1 file changed
+43
-45
README.MD
+43
-45
@@ -1,41 +1,61 @@
1
# smbcloud-cli
2
3
-**smbcloud-cli** is a robust, open-source command-line interface (CLI) designed for seamless integration with [smbcloud](https://smbcloud.xyz/)—the modern Next.js deployment platform for businesses and developers. Deploy your Next.js apps with the simplicity of a "git push", and enjoy a developer experience on par with Vercel, Cloudflare, and AWS Amplify.
4
-
5
-## Key Features
6
-
7
-- **Effortless Next.js Deployments:** Instantly deploy your Next.js projects to smbcloud with a single command or via "git push to deploy".
8
-- **Vercel/Cloudflare/AWS Amplify Alternative:** Enterprise-grade platform for modern frontend and full-stack applications.
9
-- **Cross-Platform:** Works on MacOS, Linux, and Windows.
10
-- **Open Source:** MIT-licensed and community-driven.
11
-- **Developer Friendly:** Easy to install, extend, and contribute.
3
+**smbcloud-cli** is a robust, open-source command-line interface (CLI) for [smbcloud](https://smbcloud.xyz/)—the modern cloud deployment platform. Deploy your NodeJs, Ruby, or Swift apps with the simplicity of a `push-to-deploy`.
4
5
## Installation
6
15
-Choose the installation method that best fits your workflow:
7
+[Cargo](https://doc.rust-lang.org/cargo/) is our main installation method. Setup your [Rust toolchain](https://www.rust-lang.org/tools/install) first.
8
9
### With Cargo
10
11
```bash
20
-cargo install smbcloud-cli
12
+$ cargo install smbcloud-cli
13
```
14
15
+### Install Scripts
16
+
17
+Probably broken now.
18
+
19
+#### Unix-like
20
+
21
+```bash
22
+$
23
+$ # Install system-wide
24
+$ curl -s https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.sh | sudo bash -s
25
+$
26
+$ # Install for current user
27
+$ curl -s https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.sh | bash -s -- -u
28
+$
29
+$ # Install in specific directory
30
+$ curl -s https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.sh | bash -s -- -d <dir>
31
+$
32
+```
33
+
34
+#### PowerShell
35
+
36
+```bash
37
+Set-ExecutionPolicy Unrestricted -Scope Process; iex (iwr "https://raw.githubusercontent.com/reemus-dev/gitnr/main/scripts/install.ps1").Content
38
+```
39
### Homebrew (MacOS/Linux)
40
41
+Probably broken now.
42
+
43
```bash
26
-brew tap smbcloudXYZ/tap
27
-brew install cli
44
+$ brew tap smbcloudXYZ/tap
45
+$ brew install cli
46
```
47
48
### With NPM/Pnpm/Bun/Deno
49
50
+Probably broken now.
51
+
52
```bash
33
-npm i -g @smbcloud/cli
53
+$ npm i -g @smbcloud/cli
54
```
55
56
## Updating
57
38
-Stay up-to-date with the latest features and security patches by rerunning your installation command.
58
+Simply re-run the install command.
59
60
## Uninstallation
61
@@ -43,14 +63,14 @@ Remove smbcloud-cli using your preferred package manager:
63
64
```bash
65
# With Cargo
46
-cargo uninstall smbcloud-cli
66
+$ cargo uninstall smbcloud-cli
67
68
# With NPM
49
-npm uninstall -g @smbcloud/cli
69
+$ npm uninstall -g @smbcloud/cli
70
71
# With Homebrew
52
-brew uninstall smbcloudXYZ/tap/cli
53
-brew untap smbcloudXYZ/tap
72
+$ brew uninstall smbcloudXYZ/tap/cli
73
+$ brew untap smbcloudXYZ/tap
74
```
75
76
## Getting Started
@@ -61,34 +81,12 @@ Explore available commands and options:
81
smb --help
82
```
83
64
-## Contributing
65
-
66
-We welcome contributions from the community and businesses alike. To get started:
67
-
68
-- Ensure you have the latest Rust toolchain installed.
69
-- Clone this repository.
70
-- Set up your environment variables in `.env.local`.
71
-- Run the CLI locally with `cargo run`.
72
-
73
-For detailed contribution guidelines, please refer to [CONTRIBUTING.md](CONTRIBUTING.md) (coming soon).
74
-
75
-## Why smbcloud-cli?
76
-
77
-- **Next.js First:** Purpose-built for Next.js, with zero-config deployments and instant rollbacks.
78
-- **Git Push to Deploy:** Seamless CI/CD—just push to your git repository and your app is live.
79
-- **Enterprise-Ready:** Built with reliability and scalability in mind.
80
-- **Open Collaboration:** Inspired by industry best practices and the open-source community.
81
-- **Modern CLI Principles:** Follows [12-factor CLI app](https://medium.com/@jdxcode/12-factor-cli-apps-dd3c227a0e46) methodology for maintainability and user experience.
82
-
84
## Credits
85
85
-- Inspired by [Sugar](https://github.com/metaplex-foundation/sugar).
86
-- NPM packaging guidance by [orhun.dev](https://blog.orhun.dev/packaging-rust-for-npm/).
86
+- [Sugar](https://github.com/metaplex-foundation/sugar).
87
+- [NPM packaging for Rust](https://blog.orhun.dev/packaging-rust-for-npm/).
88
+- [Install scripts tutorial](https://reemus.dev/tldr/cli-install-script).
89
90
## License
91
90
-MIT License. See [LICENSE](LICENSE) for details.
91
-
92
----
93
-
94
-**smbcloud-cli**: The professional's choice for secure, efficient, and open Next.js cloud deployments—experience the power of "git push to deploy".
92
+MIT License.