nexusforge-cli 1.0.1 → 1.0.2
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 +128 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# NexusForge CLI
|
|
2
|
+
|
|
3
|
+
AI-powered development companion for your terminal. Like Claude Code, but for NexusForge.
|
|
4
|
+
|
|
5
|
+
```
|
|
6
|
+
███╗ ██╗███████╗██╗ ██╗██╗ ██╗███████╗
|
|
7
|
+
████╗ ██║██╔════╝╚██╗██╔╝██║ ██║██╔════╝
|
|
8
|
+
██╔██╗ ██║█████╗ ╚███╔╝ ██║ ██║███████╗
|
|
9
|
+
██║╚██╗██║██╔══╝ ██╔██╗ ██║ ██║╚════██║
|
|
10
|
+
██║ ╚████║███████╗██╔╝ ██╗╚██████╔╝███████║
|
|
11
|
+
╚═╝ ╚═══╝╚══════╝╚═╝ ╚═╝ ╚═════╝ ╚══════╝
|
|
12
|
+
███████╗ ██████╗ ██████╗ ██████╗ ███████╗
|
|
13
|
+
██╔════╝██╔═══██╗██╔══██╗██╔════╝ ██╔════╝
|
|
14
|
+
█████╗ ██║ ██║██████╔╝██║ ███╗█████╗
|
|
15
|
+
██╔══╝ ██║ ██║██╔══██╗██║ ██║██╔══╝
|
|
16
|
+
██║ ╚██████╔╝██║ ██║╚██████╔╝███████╗
|
|
17
|
+
╚═╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝ ╚══════╝
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Installation
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install -g nexusforge-cli
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Quick Start
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
# Start NexusForge CLI
|
|
30
|
+
nexusforge
|
|
31
|
+
|
|
32
|
+
# First run will open browser for authentication
|
|
33
|
+
# After auth, you're ready to chat!
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Features
|
|
37
|
+
|
|
38
|
+
- **Interactive AI Chat** - Chat with NexusForge AI directly in your terminal
|
|
39
|
+
- **Browser Authentication** - Secure OAuth-style device authorization flow
|
|
40
|
+
- **Command Execution** - AI can suggest and execute shell commands
|
|
41
|
+
- **File Operations** - Read files into context with `/read`
|
|
42
|
+
- **Session Sync** - Sync conversations between CLI and web UI
|
|
43
|
+
- **Slash Commands** - Quick actions with `/help`, `/clear`, `/history`, and more
|
|
44
|
+
|
|
45
|
+
## Commands
|
|
46
|
+
|
|
47
|
+
### CLI Arguments
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
nexusforge # Start interactive chat
|
|
51
|
+
nexusforge login # Authenticate with browser
|
|
52
|
+
nexusforge logout # Clear saved credentials
|
|
53
|
+
nexusforge status # Check connection status
|
|
54
|
+
nexusforge --session <token> # Sync with web session
|
|
55
|
+
nexusforge --model <name> # Use specific model
|
|
56
|
+
nexusforge --cwd <path> # Set working directory
|
|
57
|
+
nexusforge --version # Show version
|
|
58
|
+
nexusforge --help # Show help
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Slash Commands (in chat)
|
|
62
|
+
|
|
63
|
+
| Command | Description |
|
|
64
|
+
|---------|-------------|
|
|
65
|
+
| `/help` | Show available commands |
|
|
66
|
+
| `/exit`, `/quit`, `/q` | Exit CLI |
|
|
67
|
+
| `/clear`, `/c` | Clear screen |
|
|
68
|
+
| `/history` | Show conversation history |
|
|
69
|
+
| `/resume [id]` | Resume previous conversation |
|
|
70
|
+
| `/model [name]` | Get or set the model |
|
|
71
|
+
| `/status` | Show connection status |
|
|
72
|
+
| `/read <path>` | Read a file into context |
|
|
73
|
+
| `/exec <cmd>` | Execute a shell command |
|
|
74
|
+
|
|
75
|
+
## Authentication
|
|
76
|
+
|
|
77
|
+
On first run, NexusForge CLI uses a secure device authorization flow:
|
|
78
|
+
|
|
79
|
+
1. CLI displays a verification URL
|
|
80
|
+
2. Open the URL in your browser
|
|
81
|
+
3. Log in to NexusForge (if not already)
|
|
82
|
+
4. Click "Authorize CLI"
|
|
83
|
+
5. CLI automatically receives your token
|
|
84
|
+
|
|
85
|
+
Your credentials are stored securely in `~/.nexusforge/config.json`.
|
|
86
|
+
|
|
87
|
+
## Session Sync
|
|
88
|
+
|
|
89
|
+
Sync conversations between the web UI and CLI:
|
|
90
|
+
|
|
91
|
+
1. In the web UI, click the **Terminal** button in the header
|
|
92
|
+
2. A command is copied to your clipboard
|
|
93
|
+
3. Paste and run in your terminal: `nexusforge --session <token>`
|
|
94
|
+
4. Your web conversation continues in the CLI
|
|
95
|
+
|
|
96
|
+
## Configuration
|
|
97
|
+
|
|
98
|
+
Config is stored at `~/.nexusforge/config.json`:
|
|
99
|
+
|
|
100
|
+
```json
|
|
101
|
+
{
|
|
102
|
+
"apiUrl": "https://nexusconnectbridge.automatanexus.com/api/v1/bridge",
|
|
103
|
+
"accessToken": "...",
|
|
104
|
+
"username": "your-username",
|
|
105
|
+
"defaultModel": "NexusForge",
|
|
106
|
+
"autoExecute": true
|
|
107
|
+
}
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Requirements
|
|
111
|
+
|
|
112
|
+
- Node.js 18+
|
|
113
|
+
- NexusForge account ([Sign up](https://nexusforge.automatanexus.com))
|
|
114
|
+
|
|
115
|
+
## Platform Support
|
|
116
|
+
|
|
117
|
+
- **Linux** - Full support
|
|
118
|
+
- **macOS** - Full support
|
|
119
|
+
- **Windows** - Full support (including WSL)
|
|
120
|
+
|
|
121
|
+
## Links
|
|
122
|
+
|
|
123
|
+
- [NexusForge Web](https://nexusforge.automatanexus.com)
|
|
124
|
+
- [AutomataNexus](https://automatanexus.com)
|
|
125
|
+
|
|
126
|
+
## License
|
|
127
|
+
|
|
128
|
+
MIT - AutomataNexus, LLC
|