1 # Installation
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.
4
5 ### With Cargo
6
7 ```bash
8 $ cargo install smbcloud-cli
9 ```
10
11 ### Install Scripts
12
13 Probably broken now.
14
15 #### Unix-like
16
17 ```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 $
28 ```
29
30 #### PowerShell
31
32 ```bash
33 Set-ExecutionPolicy Unrestricted -Scope Process; iex (iwr "https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.ps1").Content
34 ```
35
36 ### Homebrew (MacOS/Linux)
37
38 Probably broken now.
39
40 ```bash
41 $ brew tap smbcloudXYZ/tap
42 $ brew install cli
43 ```
44
45 ### With NPM/Pnpm/Bun/Deno
46
47 Probably broken now.
48
49 ```bash
50 $ npm i -g @smbcloud/cli
51 ```
52
53 ## Updating
54
55 Simply re-run the install command.
56
57 ## Uninstallation
58
59 Remove smbcloud-cli using your preferred package manager:
60
61 ```bash
62 # With Cargo
63 $ cargo uninstall smbcloud-cli
64
65 # With NPM
66 $ npm uninstall -g @smbcloud/cli
67
68 # With Homebrew
69 $ brew uninstall smbcloudXYZ/tap/cli
70 $ brew untap smbcloudXYZ/tap
71 ```
72
73 ## Getting Started
74
75 Explore available commands and options:
76
77 ```bash
78 smb --help
79 ```
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).