|
1 | 1 | # Installation |
2 | 2 |
|
3 | | -[Cargo](https://doc.rust-lang.org/cargo/) is our main installation method. Setup your [Rust toolchain](https://www.rust-lang.org/tools/install) first. |
| 3 | +Deploying to the cloud should be absolutely frictionless. We provide pre-built binaries and seamless installation across all major platforms. Choose the method that best fits your workflow. |
4 | 4 |
|
5 | | -### With Cargo |
| 5 | +### Homebrew (macOS & Linux) |
6 | 6 |
|
7 | | -```bash |
8 | | -$ cargo install smbcloud-cli |
9 | | -``` |
10 | | - |
11 | | -### Install Scripts |
12 | | - |
13 | | -Probably broken now. |
14 | | - |
15 | | -#### Unix-like |
| 7 | +The fastest way to get started on Apple Silicon, Intel Macs, and Linux. We maintain an official tap with highly optimized, pre-built binaries so you can install `smb` in seconds. |
16 | 8 |
|
17 | 9 | ```bash |
18 | | -$ |
19 | | -$ # Install system-wide |
20 | | -$ curl -s https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.sh | sudo bash -s |
21 | | -$ |
22 | | -$ # Install for current user |
23 | | -$ curl -s https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.sh | bash -s -- -u |
24 | | -$ |
25 | | -$ # Install in specific directory |
26 | | -$ curl -s https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.sh | bash -s -- -d <dir> |
27 | | -$ |
| 10 | +brew tap smbcloudXYZ/tap |
| 11 | +brew install cli |
28 | 12 | ``` |
29 | 13 |
|
30 | | -#### PowerShell |
| 14 | +### Node Package Managers (npm / pnpm / bun / yarn) |
| 15 | + |
| 16 | +Perfect for JavaScript and TypeScript developers. The CLI is distributed as a lightweight, native binary wrapper. |
31 | 17 |
|
32 | 18 | ```bash |
33 | | -Set-ExecutionPolicy Unrestricted -Scope Process; iex (iwr "https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.ps1").Content |
| 19 | +npm install -g @smbcloud/cli |
34 | 20 | ``` |
35 | 21 |
|
36 | | -### Homebrew (MacOS/Linux) |
| 22 | +## Updating |
37 | 23 |
|
38 | | -Probably broken now. |
| 24 | +To get the latest features, speed improvements, and security patches: |
39 | 25 |
|
40 | 26 | ```bash |
41 | | -$ brew tap smbcloudXYZ/tap |
42 | | -$ brew install cli |
43 | | -``` |
| 27 | +# Homebrew |
| 28 | +brew upgrade cli |
44 | 29 |
|
45 | | -### With NPM/Pnpm/Bun/Deno |
| 30 | +# NPM |
| 31 | +npm update -g @smbcloud/cli |
46 | 32 |
|
47 | | -Probably broken now. |
48 | 33 |
|
49 | | -```bash |
50 | | -$ npm i -g @smbcloud/cli |
51 | 34 | ``` |
52 | 35 |
|
53 | | -## Updating |
54 | | - |
55 | | -Simply re-run the install command. |
56 | | - |
57 | 36 | ## Uninstallation |
58 | 37 |
|
59 | | -Remove smbcloud-cli using your preferred package manager: |
| 38 | +Remove the CLI using your preferred package manager: |
60 | 39 |
|
61 | 40 | ```bash |
62 | | -# With Cargo |
63 | | -$ cargo uninstall smbcloud-cli |
| 41 | +# Homebrew |
| 42 | +brew uninstall cli |
| 43 | +brew untap smbcloudXYZ/tap |
| 44 | + |
| 45 | +# NPM |
| 46 | +npm uninstall -g @smbcloud/cli |
64 | 47 |
|
65 | | -# With NPM |
66 | | -$ npm uninstall -g @smbcloud/cli |
67 | 48 |
|
68 | | -# With Homebrew |
69 | | -$ brew uninstall smbcloudXYZ/tap/cli |
70 | | -$ brew untap smbcloudXYZ/tap |
71 | 49 | ``` |
72 | 50 |
|
73 | 51 | ## Getting Started |
74 | 52 |
|
75 | | -Explore available commands and options: |
| 53 | +Explore the available commands and deploy your first app: |
76 | 54 |
|
77 | 55 | ```bash |
78 | 56 | smb --help |
79 | 57 | ``` |
80 | | - |
81 | | -## Credits |
82 | | - |
83 | | -- [Sugar](https://github.com/metaplex-foundation/sugar). |
84 | | -- [NPM packaging for Rust](https://blog.orhun.dev/packaging-rust-for-npm/). |
85 | | -- [Install scripts tutorial](https://reemus.dev/tldr/cli-install-script). |
0 commit comments