sphereai-cli 1.0.20 → 1.0.22

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 (71) hide show
  1. package/.env +12 -12
  2. package/README.md +282 -282
  3. package/dist/index.js +1 -108
  4. package/package.json +52 -50
  5. package/dist/commands/auth.d.ts +0 -3
  6. package/dist/commands/auth.d.ts.map +0 -1
  7. package/dist/commands/auth.js +0 -193
  8. package/dist/commands/auth.js.map +0 -1
  9. package/dist/commands/debug.d.ts +0 -3
  10. package/dist/commands/debug.d.ts.map +0 -1
  11. package/dist/commands/debug.js +0 -49
  12. package/dist/commands/debug.js.map +0 -1
  13. package/dist/commands/execute.d.ts +0 -3
  14. package/dist/commands/execute.d.ts.map +0 -1
  15. package/dist/commands/execute.js +0 -189
  16. package/dist/commands/execute.js.map +0 -1
  17. package/dist/commands/files.d.ts +0 -3
  18. package/dist/commands/files.d.ts.map +0 -1
  19. package/dist/commands/files.js +0 -235
  20. package/dist/commands/files.js.map +0 -1
  21. package/dist/commands/init.d.ts +0 -3
  22. package/dist/commands/init.d.ts.map +0 -1
  23. package/dist/commands/init.js +0 -71
  24. package/dist/commands/init.js.map +0 -1
  25. package/dist/commands/prompts.d.ts +0 -3
  26. package/dist/commands/prompts.d.ts.map +0 -1
  27. package/dist/commands/prompts.js +0 -72
  28. package/dist/commands/prompts.js.map +0 -1
  29. package/dist/index.d.ts +0 -3
  30. package/dist/index.d.ts.map +0 -1
  31. package/dist/index.js.map +0 -1
  32. package/dist/services/api-client.d.ts +0 -15
  33. package/dist/services/api-client.d.ts.map +0 -1
  34. package/dist/services/api-client.js +0 -92
  35. package/dist/services/api-client.js.map +0 -1
  36. package/dist/services/auth-service.d.ts +0 -23
  37. package/dist/services/auth-service.d.ts.map +0 -1
  38. package/dist/services/auth-service.js +0 -166
  39. package/dist/services/auth-service.js.map +0 -1
  40. package/dist/services/cli-api-client.d.ts +0 -18
  41. package/dist/services/cli-api-client.d.ts.map +0 -1
  42. package/dist/services/cli-api-client.js +0 -57
  43. package/dist/services/cli-api-client.js.map +0 -1
  44. package/dist/services/config-service.d.ts +0 -46
  45. package/dist/services/config-service.d.ts.map +0 -1
  46. package/dist/services/config-service.js +0 -101
  47. package/dist/services/config-service.js.map +0 -1
  48. package/dist/services/file-tracking-service.d.ts +0 -62
  49. package/dist/services/file-tracking-service.d.ts.map +0 -1
  50. package/dist/services/file-tracking-service.js +0 -207
  51. package/dist/services/file-tracking-service.js.map +0 -1
  52. package/dist/types/api-types.d.ts +0 -83
  53. package/dist/types/api-types.d.ts.map +0 -1
  54. package/dist/types/api-types.js +0 -10
  55. package/dist/types/api-types.js.map +0 -1
  56. package/dist/utils/axios-debug.d.ts +0 -15
  57. package/dist/utils/axios-debug.d.ts.map +0 -1
  58. package/dist/utils/axios-debug.js +0 -53
  59. package/dist/utils/axios-debug.js.map +0 -1
  60. package/dist/utils/errors.d.ts +0 -38
  61. package/dist/utils/errors.d.ts.map +0 -1
  62. package/dist/utils/errors.js +0 -115
  63. package/dist/utils/errors.js.map +0 -1
  64. package/dist/utils/formatters.d.ts +0 -35
  65. package/dist/utils/formatters.d.ts.map +0 -1
  66. package/dist/utils/formatters.js +0 -101
  67. package/dist/utils/formatters.js.map +0 -1
  68. package/dist/utils/sphereignore.d.ts +0 -34
  69. package/dist/utils/sphereignore.d.ts.map +0 -1
  70. package/dist/utils/sphereignore.js +0 -148
  71. package/dist/utils/sphereignore.js.map +0 -1
package/.env CHANGED
@@ -1,13 +1,13 @@
1
- # Main API URL (for prompts and other resources after authentication)
2
- #SPHEREAI_API_URL=https://localhost:5001
3
- SPHEREAI_API_URL=https://api.develop.sphereai.nava.com.br
4
-
5
- # CLI API URL (for key-based authentication)
6
- SPHEREAI_CLI_API_URL=https://cli.api.develop.sphereai.nava.com.br
7
-
8
- # OAuth2 URL (for legacy OAuth authentication)
9
- SPHEREAI_AUTH_URL=http://localhost:3000/login?callback=http://localhost:3001/callback
10
- SPHEREAI_OAUTH_CALLBACK_PORT=3001
11
-
12
- # develop config
1
+ # Main API URL (for prompts and other resources after authentication)
2
+ #SPHEREAI_API_URL=https://localhost:5001
3
+ SPHEREAI_API_URL=https://api.develop.sphereai.nava.com.br
4
+
5
+ # CLI API URL (for key-based authentication)
6
+ SPHEREAI_CLI_API_URL=https://cli.api.develop.sphereai.nava.com.br
7
+
8
+ # OAuth2 URL (for legacy OAuth authentication)
9
+ SPHEREAI_AUTH_URL=http://localhost:3000/login?callback=http://localhost:3001/callback
10
+ SPHEREAI_OAUTH_CALLBACK_PORT=3001
11
+
12
+ # develop config
13
13
  NODE_TLS_REJECT_UNAUTHORIZED=0
package/README.md CHANGED
@@ -1,282 +1,282 @@
1
- # SphereAI CLI
2
-
3
- Official command-line interface for interacting with SphereAI services.
4
-
5
- ## Installation
6
-
7
- ```bash
8
- npm install -g sphereai-cli
9
- ```
10
-
11
- ## Quick Start
12
-
13
- ### 1. Authenticate
14
-
15
- Login using your UserChannelKey (provided by your administrator):
16
-
17
- ```bash
18
- sphereai auth login YOUR_USER_CHANNEL_KEY
19
- ```
20
-
21
- ### 2. Verify Authentication
22
-
23
- ```bash
24
- sphereai auth whoami
25
- ```
26
-
27
- ### 3. Start Using
28
-
29
- You're ready to use SphereAI CLI commands.
30
-
31
- ## Commands
32
-
33
- ### Initialization
34
-
35
- Initialize SphereAI in your project directory.
36
-
37
- | Command | Description |
38
- |---------|-------------|
39
- | `sphereai init` | Create a default .sphereignore file |
40
-
41
- **Options:**
42
-
43
- | Option | Description |
44
- |--------|-------------|
45
- | `-f, --force` | Overwrite existing .sphereignore file |
46
-
47
- **Examples:**
48
-
49
- ```bash
50
- # Initialize with default .sphereignore
51
- sphereai init
52
-
53
- # Overwrite existing .sphereignore
54
- sphereai init --force
55
- ```
56
-
57
- ### Authentication
58
-
59
- | Command | Description |
60
- |---------|-------------|
61
- | `sphereai auth login <key>` | Authenticate with your UserChannelKey |
62
- | `sphereai auth logout` | Sign out and clear stored credentials |
63
- | `sphereai auth whoami` | Display your current user information |
64
- | `sphereai auth config` | Display current configuration |
65
-
66
- **Examples:**
67
-
68
- ```bash
69
- # Login
70
- sphereai auth login YOUR_USER_CHANNEL_KEY
71
-
72
- # Check who you are logged in as
73
- sphereai auth whoami
74
-
75
- # View as JSON
76
- sphereai auth whoami --output json
77
-
78
- # Logout
79
- sphereai auth logout
80
- ```
81
-
82
- ### Prompts
83
-
84
- List and view available AI prompts.
85
-
86
- | Command | Description |
87
- |---------|-------------|
88
- | `sphereai prompts list` | List all available prompts |
89
- | `sphereai prompts get <id>` | Get details of a specific prompt by ID |
90
-
91
- **Examples:**
92
-
93
- ```bash
94
- # List all prompts
95
- sphereai prompts list
96
-
97
- # List prompts in JSON format
98
- sphereai prompts list --output json
99
-
100
- # Get details of a specific prompt
101
- sphereai prompts get 123
102
-
103
- # Get prompt details in JSON format
104
- sphereai prompts get 123 --output json
105
- ```
106
-
107
- ### File Management
108
-
109
- Track files for AI processing. Works similar to git staging.
110
-
111
- | Command | Description |
112
- |---------|-------------|
113
- | `sphereai files add [path]` | Add files to tracking |
114
- | `sphereai files list` | List all tracked files |
115
- | `sphereai files remove <path>` | Remove a file from tracking |
116
- | `sphereai files clear --force` | Clear all tracked files |
117
- | `sphereai files status` | Show status of tracked files |
118
- | `sphereai files ignore` | Show current ignore patterns |
119
-
120
- ### AI Command Execution
121
-
122
- Execute AI commands with your tracked files.
123
-
124
- | Command | Description |
125
- |---------|-------------|
126
- | `sphereai execute -p <id>` | Execute AI command with tracked files |
127
-
128
- **File Management Examples:**
129
-
130
- ```bash
131
- # Add all files from current directory
132
- sphereai files add .
133
-
134
- # Add a specific file
135
- sphereai files add myfile.txt
136
-
137
- # Add files from a directory
138
- sphereai files add src/
139
-
140
- # List tracked files
141
- sphereai files list
142
-
143
- # List with details (size, date)
144
- sphereai files list --verbose
145
-
146
- # Check status
147
- sphereai files status
148
-
149
- # Remove a file from tracking
150
- sphereai files remove myfile.txt
151
-
152
- # Clear all tracked files
153
- sphereai files clear --force
154
- ```
155
-
156
- **Execution Examples:**
157
-
158
- ```bash
159
- # Execute AI command with tracked files
160
- sphereai execute --prompt-id 123
161
-
162
- # Execute with JSON output
163
- sphereai execute --prompt-id 123 --output json
164
-
165
- # Save detailed response to a specific directory
166
- sphereai execute --prompt-id 123 --save-dir ./responses
167
- ```
168
-
169
- #### Complete Workflow Example
170
-
171
- ```bash
172
- # 1. Login
173
- sphereai auth login YOUR_USER_CHANNEL_KEY
174
-
175
- # 2. List available prompts to find the one you need
176
- sphereai prompts list
177
-
178
- # 3. Get details of a specific prompt
179
- sphereai prompts get 123
180
-
181
- # 4. Add files to track
182
- sphereai files add .
183
-
184
- # 5. Check what files are tracked
185
- sphereai files list
186
-
187
- # 6. Execute AI command with tracked files
188
- sphereai execute --prompt-id 123
189
-
190
- # 7. The detailed response is automatically saved to a markdown file
191
- # 8. Clear tracked files when done
192
- sphereai files clear --force
193
- ```
194
-
195
- ### .sphereignore File
196
-
197
- Create a `.sphereignore` file in your project root to exclude files from tracking. It works like `.gitignore`.
198
-
199
- **Example `.sphereignore`:**
200
-
201
- ```gitignore
202
- # Dependencies
203
- node_modules/
204
-
205
- # Build outputs
206
- dist/
207
- build/
208
-
209
- # Environment files
210
- .env
211
- .env.*
212
-
213
- # Logs
214
- *.log
215
-
216
- # IDE files
217
- .vscode/
218
- .idea/
219
-
220
- # OS files
221
- .DS_Store
222
- ```
223
-
224
- If no `.sphereignore` file exists, common patterns are ignored by default (node_modules, .git, dist, build, .env, etc.).
225
-
226
- ## Output Formats
227
-
228
- All commands support two output formats:
229
-
230
- ```bash
231
- # Table format (default) - human readable
232
- sphereai auth whoami
233
-
234
- # JSON format - for scripting
235
- sphereai auth whoami --output json
236
- ```
237
-
238
- ## Global Options
239
-
240
- | Option | Description |
241
- |--------|-------------|
242
- | `--output <format>` | Output format: `table` (default) or `json` |
243
- | `--help` | Show help for any command |
244
- | `--version` | Show CLI version |
245
-
246
- ## Configuration
247
-
248
- Your credentials are stored securely in your user configuration directory. Use `sphereai auth config` to view the current configuration.
249
-
250
- ## Troubleshooting
251
-
252
- ### Token Expired
253
-
254
- Re-authenticate with your UserChannelKey:
255
-
256
- ```bash
257
- sphereai auth login YOUR_USER_CHANNEL_KEY
258
- ```
259
-
260
- ### Clear All Data
261
-
262
- ```bash
263
- sphereai auth logout
264
- ```
265
-
266
- ### Check Your Configuration
267
-
268
- ```bash
269
- sphereai auth config
270
- ```
271
-
272
- ## Requirements
273
-
274
- - Node.js 14.0.0 or higher
275
-
276
- ## Support
277
-
278
- For issues and questions, please contact your SphereAI administrator.
279
-
280
- ## License
281
-
282
- ISC
1
+ # SphereAI CLI
2
+
3
+ Official command-line interface for interacting with SphereAI services.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install -g sphereai-cli
9
+ ```
10
+
11
+ ## Quick Start
12
+
13
+ ### 1. Authenticate
14
+
15
+ Login using your UserChannelKey (provided by your administrator):
16
+
17
+ ```bash
18
+ sphereai auth login YOUR_USER_CHANNEL_KEY
19
+ ```
20
+
21
+ ### 2. Verify Authentication
22
+
23
+ ```bash
24
+ sphereai auth whoami
25
+ ```
26
+
27
+ ### 3. Start Using
28
+
29
+ You're ready to use SphereAI CLI commands.
30
+
31
+ ## Commands
32
+
33
+ ### Initialization
34
+
35
+ Initialize SphereAI in your project directory.
36
+
37
+ | Command | Description |
38
+ |---------|-------------|
39
+ | `sphereai init` | Create a default .sphereignore file |
40
+
41
+ **Options:**
42
+
43
+ | Option | Description |
44
+ |--------|-------------|
45
+ | `-f, --force` | Overwrite existing .sphereignore file |
46
+
47
+ **Examples:**
48
+
49
+ ```bash
50
+ # Initialize with default .sphereignore
51
+ sphereai init
52
+
53
+ # Overwrite existing .sphereignore
54
+ sphereai init --force
55
+ ```
56
+
57
+ ### Authentication
58
+
59
+ | Command | Description |
60
+ |---------|-------------|
61
+ | `sphereai auth login <key>` | Authenticate with your UserChannelKey |
62
+ | `sphereai auth logout` | Sign out and clear stored credentials |
63
+ | `sphereai auth whoami` | Display your current user information |
64
+ | `sphereai auth config` | Display current configuration |
65
+
66
+ **Examples:**
67
+
68
+ ```bash
69
+ # Login
70
+ sphereai auth login YOUR_USER_CHANNEL_KEY
71
+
72
+ # Check who you are logged in as
73
+ sphereai auth whoami
74
+
75
+ # View as JSON
76
+ sphereai auth whoami --output json
77
+
78
+ # Logout
79
+ sphereai auth logout
80
+ ```
81
+
82
+ ### Prompts
83
+
84
+ List and view available AI prompts.
85
+
86
+ | Command | Description |
87
+ |---------|-------------|
88
+ | `sphereai prompts list` | List all available prompts |
89
+ | `sphereai prompts get <id>` | Get details of a specific prompt by ID |
90
+
91
+ **Examples:**
92
+
93
+ ```bash
94
+ # List all prompts
95
+ sphereai prompts list
96
+
97
+ # List prompts in JSON format
98
+ sphereai prompts list --output json
99
+
100
+ # Get details of a specific prompt
101
+ sphereai prompts get 123
102
+
103
+ # Get prompt details in JSON format
104
+ sphereai prompts get 123 --output json
105
+ ```
106
+
107
+ ### File Management
108
+
109
+ Track files for AI processing. Works similar to git staging.
110
+
111
+ | Command | Description |
112
+ |---------|-------------|
113
+ | `sphereai files add [path]` | Add files to tracking |
114
+ | `sphereai files list` | List all tracked files |
115
+ | `sphereai files remove <path>` | Remove a file from tracking |
116
+ | `sphereai files clear --force` | Clear all tracked files |
117
+ | `sphereai files status` | Show status of tracked files |
118
+ | `sphereai files ignore` | Show current ignore patterns |
119
+
120
+ ### AI Command Execution
121
+
122
+ Execute AI commands with your tracked files.
123
+
124
+ | Command | Description |
125
+ |---------|-------------|
126
+ | `sphereai execute -p <id>` | Execute AI command with tracked files |
127
+
128
+ **File Management Examples:**
129
+
130
+ ```bash
131
+ # Add all files from current directory
132
+ sphereai files add .
133
+
134
+ # Add a specific file
135
+ sphereai files add myfile.txt
136
+
137
+ # Add files from a directory
138
+ sphereai files add src/
139
+
140
+ # List tracked files
141
+ sphereai files list
142
+
143
+ # List with details (size, date)
144
+ sphereai files list --verbose
145
+
146
+ # Check status
147
+ sphereai files status
148
+
149
+ # Remove a file from tracking
150
+ sphereai files remove myfile.txt
151
+
152
+ # Clear all tracked files
153
+ sphereai files clear --force
154
+ ```
155
+
156
+ **Execution Examples:**
157
+
158
+ ```bash
159
+ # Execute AI command with tracked files
160
+ sphereai execute --prompt-id 123
161
+
162
+ # Execute with JSON output
163
+ sphereai execute --prompt-id 123 --output json
164
+
165
+ # Save detailed response to a specific directory
166
+ sphereai execute --prompt-id 123 --save-dir ./responses
167
+ ```
168
+
169
+ #### Complete Workflow Example
170
+
171
+ ```bash
172
+ # 1. Login
173
+ sphereai auth login YOUR_USER_CHANNEL_KEY
174
+
175
+ # 2. List available prompts to find the one you need
176
+ sphereai prompts list
177
+
178
+ # 3. Get details of a specific prompt
179
+ sphereai prompts get 123
180
+
181
+ # 4. Add files to track
182
+ sphereai files add .
183
+
184
+ # 5. Check what files are tracked
185
+ sphereai files list
186
+
187
+ # 6. Execute AI command with tracked files
188
+ sphereai execute --prompt-id 123
189
+
190
+ # 7. The detailed response is automatically saved to a markdown file
191
+ # 8. Clear tracked files when done
192
+ sphereai files clear --force
193
+ ```
194
+
195
+ ### .sphereignore File
196
+
197
+ Create a `.sphereignore` file in your project root to exclude files from tracking. It works like `.gitignore`.
198
+
199
+ **Example `.sphereignore`:**
200
+
201
+ ```gitignore
202
+ # Dependencies
203
+ node_modules/
204
+
205
+ # Build outputs
206
+ dist/
207
+ build/
208
+
209
+ # Environment files
210
+ .env
211
+ .env.*
212
+
213
+ # Logs
214
+ *.log
215
+
216
+ # IDE files
217
+ .vscode/
218
+ .idea/
219
+
220
+ # OS files
221
+ .DS_Store
222
+ ```
223
+
224
+ If no `.sphereignore` file exists, common patterns are ignored by default (node_modules, .git, dist, build, .env, etc.).
225
+
226
+ ## Output Formats
227
+
228
+ All commands support two output formats:
229
+
230
+ ```bash
231
+ # Table format (default) - human readable
232
+ sphereai auth whoami
233
+
234
+ # JSON format - for scripting
235
+ sphereai auth whoami --output json
236
+ ```
237
+
238
+ ## Global Options
239
+
240
+ | Option | Description |
241
+ |--------|-------------|
242
+ | `--output <format>` | Output format: `table` (default) or `json` |
243
+ | `--help` | Show help for any command |
244
+ | `--version` | Show CLI version |
245
+
246
+ ## Configuration
247
+
248
+ Your credentials are stored securely in your user configuration directory. Use `sphereai auth config` to view the current configuration.
249
+
250
+ ## Troubleshooting
251
+
252
+ ### Token Expired
253
+
254
+ Re-authenticate with your UserChannelKey:
255
+
256
+ ```bash
257
+ sphereai auth login YOUR_USER_CHANNEL_KEY
258
+ ```
259
+
260
+ ### Clear All Data
261
+
262
+ ```bash
263
+ sphereai auth logout
264
+ ```
265
+
266
+ ### Check Your Configuration
267
+
268
+ ```bash
269
+ sphereai auth config
270
+ ```
271
+
272
+ ## Requirements
273
+
274
+ - Node.js 14.0.0 or higher
275
+
276
+ ## Support
277
+
278
+ For issues and questions, please contact your SphereAI administrator.
279
+
280
+ ## License
281
+
282
+ ISC