@smbcloud / cli
Code Commits Issues Pulls Cloud Agent CI/CD
feature/ruby-runner
claude/smbcloud-github-app-k9641p development feature/apps feature/build-release feature/ci-docs feature/ci-ruby-gems feature/cicd feature/completion feature/dist-nuget feature/fix-ci-sdk-pypi-rubygem feature/fix-clippy-on-stable-channel feature/fix-deployment-script feature/github-email feature/gresiq-v1 feature/project-new-structure feature/rsync-deploy feature/ruby-runner feature/sdk-npm feature/sdk-workflows feature/smbcloud-cli-release-npm feature/smbcloud-deploy feature/wasm main release/v0.7.4
md 94 lines 2.83 KB
Rendered Raw
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.
12
13 ## Installation
14
15 Choose the installation method that best fits your workflow:
16
17 ### With Cargo
18
19 ```bash
20 cargo install smbcloud-cli
21 ```
22
23 ### Homebrew (MacOS/Linux)
24
25 ```bash
26 brew tap smbcloudXYZ/tap
27 brew install cli
28 ```
29
30 ### With NPM/Pnpm/Bun/Deno
31
32 ```bash
33 npm i -g @smbcloud/cli
34 ```
35
36 ## Updating
37
38 Stay up-to-date with the latest features and security patches by rerunning your installation command.
39
40 ## Uninstallation
41
42 Remove smbcloud-cli using your preferred package manager:
43
44 ```bash
45 # With Cargo
46 cargo uninstall smbcloud-cli
47
48 # With NPM
49 npm uninstall -g @smbcloud/cli
50
51 # With Homebrew
52 brew uninstall smbcloudXYZ/tap/cli
53 brew untap smbcloudXYZ/tap
54 ```
55
56 ## Getting Started
57
58 Explore available commands and options:
59
60 ```bash
61 smb --help
62 ```
63
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
83 ## Credits
84
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/).
87
88 ## License
89
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".