Skip to content

Commit 9ef0126

Browse files
committed
Rewrite install guide with updated Homebrew and npm steps
1 parent 840f9a1 commit 9ef0126

1 file changed

Lines changed: 23 additions & 51 deletions

File tree

docs/install.md

Lines changed: 23 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,57 @@
11
# Installation
22

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.
44

5-
### With Cargo
5+
### Homebrew (macOS & Linux)
66

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.
168

179
```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
2812
```
2913

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.
3117

3218
```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
3420
```
3521

36-
### Homebrew (MacOS/Linux)
22+
## Updating
3723

38-
Probably broken now.
24+
To get the latest features, speed improvements, and security patches:
3925

4026
```bash
41-
$ brew tap smbcloudXYZ/tap
42-
$ brew install cli
43-
```
27+
# Homebrew
28+
brew upgrade cli
4429

45-
### With NPM/Pnpm/Bun/Deno
30+
# NPM
31+
npm update -g @smbcloud/cli
4632

47-
Probably broken now.
4833

49-
```bash
50-
$ npm i -g @smbcloud/cli
5134
```
5235

53-
## Updating
54-
55-
Simply re-run the install command.
56-
5736
## Uninstallation
5837

59-
Remove smbcloud-cli using your preferred package manager:
38+
Remove the CLI using your preferred package manager:
6039

6140
```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
6447

65-
# With NPM
66-
$ npm uninstall -g @smbcloud/cli
6748

68-
# With Homebrew
69-
$ brew uninstall smbcloudXYZ/tap/cli
70-
$ brew untap smbcloudXYZ/tap
7149
```
7250

7351
## Getting Started
7452

75-
Explore available commands and options:
53+
Explore the available commands and deploy your first app:
7654

7755
```bash
7856
smb --help
7957
```
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

Comments
 (0)