You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!-- Reference any GitHub issues resolved by this PR -->
Closes#3216
## Introduced changes
<!-- A brief description of the changes -->
-
## Checklist
<!-- Make sure all of these are complete -->
- [x] Linked relevant issue
- [x] Updated relevant documentation
- [x] Added relevant tests
- [x] Performed self-review of the code
- [x] Added changes to `CHANGELOG.md`
*[No Version Set (Linux and macOS Only)](#no-version-set-linux-and-macos-only)
21
23
*[Invalid Rust Version](#invalid-rust-version)
@@ -29,7 +31,30 @@ In this section, we will walk through the process of installing Starknet Foundry
29
31
30
32
<!-- TOC -->
31
33
32
-
## Requirements
34
+
## With Starkup
35
+
36
+
[Starkup](https://github.com/software-mansion/starkup) helps you install all the tools used to develop packages in Cairo and write contracts for Starknet, including Starknet Foundry.
37
+
38
+
> ℹ️ **Info**
39
+
>
40
+
> When using starkup on Windows, please
41
+
> use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install), as it only works on macOS and Linux.
42
+
43
+
Run the following in your terminal, then follow the onscreen instructions:
44
+
45
+
```shell
46
+
curl --proto '=https' --tlsv1.2 -sSf https://sh.starkup.sh | sh
47
+
```
48
+
49
+
To verify that Starknet Foundry was installed, open a new terminal and run
50
+
51
+
```shell
52
+
snforge --version
53
+
```
54
+
55
+
## Manual Installation
56
+
57
+
### Requirements
33
58
34
59
> 📝 **Note**
35
60
>
@@ -55,14 +80,14 @@ all installed and added to your `PATH` environment variable.
55
80
> `Universal-Sierra-Compiler` will be automatically installed if you use `asdf` or `snfoundryup`.
56
81
> You can also create `UNIVERSAL_SIERRA_COMPILER` env var to make it visible for `snforge`.
57
82
58
-
## Linux and macOS
83
+
###Linux and macOS
59
84
60
85
> ℹ️ **Info**
61
86
>
62
87
> If you already have installed Rust, Scarb and asdf simply run
63
88
> `asdf plugin add starknet-foundry`
64
89
65
-
### Install asdf
90
+
####Install asdf
66
91
67
92
Follow the instructions from [asdf docs](https://asdf-vm.com/guide/getting-started.html#getting-started).
68
93
@@ -72,7 +97,7 @@ To verify that asdf was installed, run
72
97
asdf --version
73
98
```
74
99
75
-
### Install Scarb version >= 2.8.5
100
+
####Install Scarb version >= 2.8.5
76
101
77
102
First, add Scarb plugin to asdf
78
103
@@ -100,7 +125,7 @@ scarb --version
100
125
101
126
and verify that version is >= 2.8.5
102
127
103
-
### (Optional for Scarb >= 2.10.0)[^note] Rust Installation
128
+
####(Optional for Scarb >= 2.10.0)[^note] Rust Installation
104
129
105
130
> ℹ️️ **Info**
106
131
>
@@ -127,7 +152,7 @@ and verify that version is >= 1.80.1
127
152
128
153
See [Rust docs](https://doc.rust-lang.org/beta/book/ch01-01-installation.html#installation) for more details.
129
154
130
-
### Install Starknet Foundry
155
+
####Install Starknet Foundry
131
156
132
157
First, add Starknet Foundry plugin to asdf
133
158
@@ -159,7 +184,7 @@ or
159
184
sncast --version
160
185
```
161
186
162
-
## Windows
187
+
###Windows
163
188
164
189
> 🐧 **Info** - WSL (Windows Subsystem for Linux)
165
190
>
@@ -234,6 +259,12 @@ test = "snforge test"
234
259
235
260
Shell completions allow your terminal to suggest and automatically complete commands and options when you press `Tab`.
236
261
262
+
> ⚠️ **Warning**
263
+
>
264
+
> Most users **DO NOT** need to install shell completions manually.
265
+
> [Starkup](#install-via-starkup-installation-script) automatically set up shell completions for the supported shells.
266
+
> However, if these installation methods do not support the target shell, or for any reason fail to set up completions, you can follow the instructions below to set them up manually.
0 commit comments