codehub-ghx-cli 1.0.3 → 1.0.4
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.
- package/README.md +65 -0
- package/package.json +2 -1
package/README.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# CodeHub GHX CLI
|
|
2
|
+
|
|
3
|
+
A lightweight command-line tool for the **CodeHub web application**, allowing users to add files, commit changes, and push code directly from their terminal — similar to Git, but simpler and fully connected to the CodeHub backend.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Features
|
|
8
|
+
|
|
9
|
+
- Initialize a CodeHub repo locally
|
|
10
|
+
- Add files or entire folders to staging
|
|
11
|
+
- Ignore `node_modules`, `.git`, `.env`, `.codehub` automatically
|
|
12
|
+
- Commit with messages
|
|
13
|
+
- Push all commits to the CodeHub backend
|
|
14
|
+
- Automatically uploads data to AWS S3 through CodeHub API
|
|
15
|
+
- Works inside any project folder
|
|
16
|
+
- CLI friendly, fast, and beginner-friendly
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## 📦 Installation
|
|
21
|
+
|
|
22
|
+
Install the CLI globally:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npm install -g codehub-ghx-cli
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
| Commands | Description |
|
|
30
|
+
| ------------------ | --------------------------------- |
|
|
31
|
+
| `ghx init <repolink> ` | Initialize a local CodeHub repo |
|
|
32
|
+
| `ghx add <file>` | Add a file to staging |
|
|
33
|
+
| `ghx add .` | Add all files except ignored ones |
|
|
34
|
+
| `ghx commit "msg"` | Commit staged files |
|
|
35
|
+
| `ghx push` | Upload commit to CodeHub |
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
Quick Start
|
|
39
|
+
1️⃣ Initialize a new CodeHub repo, user will be provided with repolink whenever they create repository.
|
|
40
|
+
ghx init <repo-link>
|
|
41
|
+
|
|
42
|
+
2️⃣ Add files:
|
|
43
|
+
Add a single file:
|
|
44
|
+
ghx add <file-name>
|
|
45
|
+
|
|
46
|
+
Add everything in the current folder:
|
|
47
|
+
ghx add .
|
|
48
|
+
|
|
49
|
+
3️⃣ Commit your changes
|
|
50
|
+
ghx commit "your commit message"
|
|
51
|
+
|
|
52
|
+
4️⃣ Push to CodeHub cloud
|
|
53
|
+
ghx push
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
📁 Ignored Files (Auto-Ignored)
|
|
57
|
+
|
|
58
|
+
The CLI automatically ignores the following when using ghx add .:
|
|
59
|
+
|
|
60
|
+
node_modules/
|
|
61
|
+
.git/
|
|
62
|
+
.codehub/
|
|
63
|
+
.env
|
|
64
|
+
Any .env inside subfolders
|
|
65
|
+
Any node_modules inside subfolders
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "codehub-ghx-cli",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.4",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"bin": {
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
"dependencies": {
|
|
16
16
|
"aws-sdk": "^2.1692.0",
|
|
17
17
|
"axios": "^1.13.2",
|
|
18
|
+
"codehub-ghx-cli": "^1.0.3",
|
|
18
19
|
"dotenv": "^17.2.3",
|
|
19
20
|
"path": "^0.12.7",
|
|
20
21
|
"uuid": "^13.0.0",
|