nexforge-cli 1.1.2 → 1.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +95 -34
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -10,7 +10,7 @@
10
10
 
11
11
  Deploy, manage, and scale your applications directly from your terminal with zero friction.
12
12
 
13
- [Visit NexForge](https://nexforge-sandy.vercel.app/) • [Report Bug](https://github.com/manavsharma111/nexforge/issues)
13
+ [Visit NexForge](https://nexforge-sandy.vercel.app/) • [Report Bug](mailto:manavsharma3825@gmail.com)
14
14
 
15
15
  </div>
16
16
 
@@ -32,14 +32,17 @@ Once installed, you can instantly scaffold a new project or log in to manage exi
32
32
 
33
33
  Here is exactly how you go from an empty folder to a live, deployed application on NexForge:
34
34
 
35
- 1. **Create a Project** (Optional but recommended):
36
- Run `nexforge create` to instantly scaffold a pre-configured React/Next/Vue or Backend project without any bloat.
37
- 2. **Login to NexForge**:
38
- Run `nexforge login` in your terminal. You'll need your **CLI Token** and **Project ID** from your NexForge web dashboard.
39
- 3. **Initialize the Project**:
40
- Navigate into your project folder and run `nexforge init`. This links your local directory to your NexForge servers.
41
- 4. **Deploy to the World!** 🚀
42
- Run `nexforge deploy`. The CLI will zip your code, upload it, and stream live build logs directly in your terminal. Once done, it gives you a live URL!
35
+ **1️⃣ Create a Project** *(Optional but recommended)*
36
+ Run `nexforge create` to instantly scaffold a pre-configured React/Next/Vue or Backend project without any bloat.
37
+
38
+ **2️⃣ Login to NexForge**
39
+ Run `nexforge login` in your terminal. You'll need your **CLI Token** and **Project ID** from your NexForge web dashboard.
40
+
41
+ **3️⃣ Initialize the Project**
42
+ Navigate into your project folder and run `nexforge init`. This links your local directory to your NexForge servers.
43
+
44
+ **4️⃣ Deploy to the World! 🚀**
45
+ Run `nexforge deploy`. The CLI will zip your code, upload it, and stream live build logs directly in your terminal. Once done, it gives you a live URL!
43
46
 
44
47
  ---
45
48
 
@@ -54,11 +57,21 @@ nexforge create
54
57
  ```
55
58
 
56
59
  **How it works:**
57
- 1. **Interactive UI**: Run the command and enter your project name.
58
- 2. **Choose your Stack**: Select Fullstack, Frontend Only, or Backend Only.
59
- 3. **Pick your Framework**: Next.js, React, Vue, or Express with your database of choice.
60
- 4. **Zero-Bloat Selection**: Choose add-ons like Animations (GSAP/Framer), State Management (Redux), or AI SDKs (OpenAI/Groq).
61
- 5. **Ready to Go**: The CLI installs everything. Just `cd` into your directory, run `nexforge init`, and deploy!
60
+
61
+ **1️⃣ Interactive UI**
62
+ Run the command and enter your project name.
63
+
64
+ **2️⃣ Choose your Stack**
65
+ Select Fullstack, Frontend Only, or Backend Only.
66
+
67
+ **3️⃣ Pick your Framework**
68
+ Next.js, React, Vue, or Express with your database of choice.
69
+
70
+ **4️⃣ Zero-Bloat Selection**
71
+ Choose add-ons like Animations (GSAP/Framer), State Management (Redux), or AI SDKs (OpenAI/Groq).
72
+
73
+ **5️⃣ Ready to Go**
74
+ The CLI installs everything. Just `cd` into your directory, run `nexforge init`, and deploy!
62
75
 
63
76
  ### 📂 Generated Folder Structures
64
77
 
@@ -106,35 +119,83 @@ Manage your NexForge deployments effortlessly. Below is the complete suite of co
106
119
 
107
120
  ### 🔐 Authentication & Setup
108
121
 
109
- | Command | Description |
110
- |---------|-------------|
111
- | **`nexforge login`** | Authenticate your CLI. Prompts for your Personal CLI Token and Project ID, saving credentials securely to `~/.nexforge/config.json`. |
112
- | **`nexforge init`** | Initialize a new NexForge project in the current directory. Registers your project on the server without opening a browser. |
122
+ **Authenticate your CLI**
123
+ Prompts for your Personal CLI Token and Project ID, saving credentials securely to `~/.nexforge/config.json`.
124
+ ```bash
125
+ nexforge login
126
+ ```
127
+
128
+ **Initialize a new NexForge project**
129
+ Registers your project on the server without opening a browser.
130
+ ```bash
131
+ nexforge init
132
+ ```
113
133
 
114
134
  ### 🚀 Deployment & Monitoring
115
135
 
116
- | Command | Description |
117
- |---------|-------------|
118
- | **`nexforge deploy`** | Packages your code (ignoring `node_modules`, `.git`, `.env`), uploads to NexForge, and streams live build logs via WebSocket. Returns a live URL on success. |
119
- | **`nexforge logs`** | Connects to the WebSocket server and streams real-time logs for any ongoing deployment pipelines. |
120
- | **`nexforge rollback`** | Revert to a previous stable deployment instantly with zero downtime and no rebuild required. |
136
+ **Deploy your project**
137
+ Packages your code (ignoring `node_modules`, `.git`, `.env`), uploads to NexForge, and streams live build logs via WebSocket. Returns a live URL on success.
138
+ ```bash
139
+ nexforge deploy
140
+ ```
141
+
142
+ **View live logs**
143
+ Connects to the WebSocket server and streams real-time logs for any ongoing deployment pipelines.
144
+ ```bash
145
+ nexforge logs
146
+ ```
147
+
148
+ **Rollback deployment**
149
+ Revert to a previous stable deployment instantly with zero downtime and no rebuild required.
150
+ ```bash
151
+ nexforge rollback
152
+ ```
121
153
 
122
154
  ### 🌐 Environment & Domains
123
155
 
124
- | Command | Description |
125
- |---------|-------------|
126
- | **`nexforge env push`** | Reads your local `.env` file and securely syncs all variables to your live NexForge project. |
127
- | **`nexforge env pull`** | Fetches all environment variables from your live NexForge project and saves them into your local `.env` file. |
128
- | **`nexforge domains add <domain>`** | Links a new custom domain to your project directly from the terminal. |
129
- | **`nexforge domains ls`** | Lists all custom domains currently linked to your active project. |
156
+ **Push local environment variables**
157
+ Reads your local `.env` file and securely syncs all variables to your live NexForge project.
158
+ ```bash
159
+ nexforge env push
160
+ ```
161
+
162
+ **Pull remote environment variables**
163
+ Fetches all environment variables from your live NexForge project and saves them into your local `.env` file.
164
+ ```bash
165
+ nexforge env pull
166
+ ```
167
+
168
+ **Add a custom domain**
169
+ Links a new custom domain to your project directly from the terminal.
170
+ ```bash
171
+ nexforge domains add <domain>
172
+ ```
173
+
174
+ **List custom domains**
175
+ Lists all custom domains currently linked to your active project.
176
+ ```bash
177
+ nexforge domains ls
178
+ ```
130
179
 
131
180
  ### ℹ️ Utility Commands
132
181
 
133
- | Command | Description |
134
- |---------|-------------|
135
- | **`nexforge info`** | View project status, framework, custom domains, live URL, and recent deployment status. |
136
- | **`nexforge rename`** | Change your project's subdomain instantly. Validates availability and updates your live URL. |
137
- | **`nexforge open`** | Instantly opens your live project URL in your default web browser. |
182
+ **View project info**
183
+ View project status, framework, custom domains, live URL, and recent deployment status.
184
+ ```bash
185
+ nexforge info
186
+ ```
187
+
188
+ **Rename project**
189
+ Change your project's subdomain instantly. Validates availability and updates your live URL.
190
+ ```bash
191
+ nexforge rename
192
+ ```
193
+
194
+ **Open live project**
195
+ Instantly opens your live project URL in your default web browser.
196
+ ```bash
197
+ nexforge open
198
+ ```
138
199
 
139
200
  ---
140
201
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "nexforge-cli",
3
- "version": "1.1.2",
3
+ "version": "1.1.3",
4
4
  "description": "Custom Deployment CLI for NexForge",
5
5
  "main": "index.js",
6
6
  "bin": {