@moxt-ai/cli 0.12.3 → 0.12.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 +54 -34
- package/dist/index.cjs +84763 -2013
- package/dist/index.cjs.map +1 -1
- package/package.json +4 -5
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@ Moxt CLI - AI Workspace command line tool.
|
|
|
8
8
|
npm install -g @moxt-ai/cli
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
Node.js
|
|
11
|
+
Node.js 22.13 or newer is required. Standalone runtime archives include a
|
|
12
12
|
compatible Node executable.
|
|
13
13
|
|
|
14
14
|
## Usage
|
|
@@ -71,6 +71,12 @@ Pair and operate the outbound Local Machine Connector:
|
|
|
71
71
|
# Pair the current directory as the Agent's working root
|
|
72
72
|
moxt machine connect --code <pairing-code> --root "$PWD"
|
|
73
73
|
|
|
74
|
+
# Pair and run this machine as a Mobius Runtime using the command copied from Moxt
|
|
75
|
+
moxt machine connect --code <pairing-code> --pairing <pairing-id> --relay <mobius-endpoint>
|
|
76
|
+
|
|
77
|
+
# Reconnect a previously paired Mobius Runtime
|
|
78
|
+
moxt machine start --channel <channel-id> --relay <mobius-endpoint>
|
|
79
|
+
|
|
74
80
|
# Open the interactive terminal manager
|
|
75
81
|
moxt machine manager
|
|
76
82
|
|
|
@@ -332,18 +338,18 @@ Workflow status type values are `1=todo`, `2=in-progress`, and `3=done`.
|
|
|
332
338
|
|
|
333
339
|
#### File command options
|
|
334
340
|
|
|
335
|
-
| Option
|
|
336
|
-
|
|
337
|
-
| `-w, --workspace <id>`
|
|
338
|
-
| `-s, --space <name>`
|
|
339
|
-
| `--personal`
|
|
340
|
-
| `--team-space-id <id>`
|
|
341
|
-
| `--teammate-id <id>`
|
|
342
|
-
| `-p, --path <path>`
|
|
343
|
-
| `-u, --url <url>`
|
|
344
|
-
| `--json`
|
|
345
|
-
| `-l, --local-path <path>` | Local file path (for upload)
|
|
346
|
-
| `-r, --recursive`
|
|
341
|
+
| Option | Description |
|
|
342
|
+
| ------------------------- | ---------------------------------------------------------------- |
|
|
343
|
+
| `-w, --workspace <id>` | Workspace ID (required for path mode) |
|
|
344
|
+
| `-s, --space <name>` | Space name (`personal` or teamspace name) |
|
|
345
|
+
| `--personal` | Use personal space (default when no space specified) |
|
|
346
|
+
| `--team-space-id <id>` | Team space ID |
|
|
347
|
+
| `--teammate-id <id>` | Teammate ID (teammate space) |
|
|
348
|
+
| `-p, --path <path>` | File or directory path |
|
|
349
|
+
| `-u, --url <url>` | Moxt file URL (e.g., `https://moxt.ai/w/{workspaceId}/{fileId}`) |
|
|
350
|
+
| `--json` | Emit `file read` content and metadata as JSON |
|
|
351
|
+
| `-l, --local-path <path>` | Local file path (for upload) |
|
|
352
|
+
| `-r, --recursive` | Create parent directories if needed (path mode only) |
|
|
347
353
|
|
|
348
354
|
> **Note**: `-s`, `--personal`, `--team-space-id`, and `--teammate-id` are mutually exclusive.
|
|
349
355
|
> For `file read` and `file put`, use either `--url` or `--workspace` with `--path`. They are mutually exclusive.
|
|
@@ -355,7 +361,13 @@ Without `--json`, a successful `file read` writes only the file content to stdou
|
|
|
355
361
|
`--json`, success writes exactly one JSON object to stdout using this shape:
|
|
356
362
|
|
|
357
363
|
```json
|
|
358
|
-
{
|
|
364
|
+
{
|
|
365
|
+
"path": "/notes/today.md",
|
|
366
|
+
"type": "file",
|
|
367
|
+
"entries": null,
|
|
368
|
+
"content": "Hello\n",
|
|
369
|
+
"updatedAt": 1785830950000
|
|
370
|
+
}
|
|
359
371
|
```
|
|
360
372
|
|
|
361
373
|
`updatedAt` is always a non-null Unix epoch-millisecond integer for a successful JSON
|
|
@@ -365,7 +377,14 @@ Every `file read --json` failure exits with status 1, leaves stdout empty, and w
|
|
|
365
377
|
exactly one uncolored JSON object to stderr:
|
|
366
378
|
|
|
367
379
|
```json
|
|
368
|
-
{
|
|
380
|
+
{
|
|
381
|
+
"error": {
|
|
382
|
+
"code": "not_found",
|
|
383
|
+
"message": "/missing.md does not exist",
|
|
384
|
+
"status": 404,
|
|
385
|
+
"details": { "message": "not found" }
|
|
386
|
+
}
|
|
387
|
+
}
|
|
369
388
|
```
|
|
370
389
|
|
|
371
390
|
The `error` object always contains `code`, `message`, `status`, and `details`. `status`
|
|
@@ -373,20 +392,21 @@ is the HTTP status for API responses and `null` for local or protocol failures;
|
|
|
373
392
|
`details` is the API response body when available and otherwise `null`. Stable error
|
|
374
393
|
codes are `invalid_arguments`, `configuration_error`, `authentication_failed`,
|
|
375
394
|
`not_found`, `not_a_file`, `api_error`, and `request_failed`.
|
|
395
|
+
|
|
376
396
|
> `file get-url` returns a stable Moxt URL (e.g., `https://moxt.ai/w/{workspaceId}/{fileId}`) for the given path; the URL is unchanged across writes to the same path and can be fed back into `file read --url` or `file put --url`.
|
|
377
397
|
|
|
378
398
|
## Configuration
|
|
379
399
|
|
|
380
400
|
Set the following environment variables:
|
|
381
401
|
|
|
382
|
-
| Variable
|
|
383
|
-
|
|
384
|
-
| `MOXT_API_KEY`
|
|
385
|
-
| `MOXT_HOST`
|
|
386
|
-
| `MOXT_NO_UPDATE_CHECK`
|
|
387
|
-
| `NO_UPDATE_NOTIFIER`
|
|
388
|
-
| `MOXT_TELEMETRY_DISABLED` | Set to `1` to disable anonymous usage telemetry
|
|
389
|
-
| `DO_NOT_TRACK`
|
|
402
|
+
| Variable | Description |
|
|
403
|
+
| ------------------------- | -------------------------------------------------------------------- |
|
|
404
|
+
| `MOXT_API_KEY` | Your Moxt API key |
|
|
405
|
+
| `MOXT_HOST` | API hostname (default: `api.moxt.ai`) |
|
|
406
|
+
| `MOXT_NO_UPDATE_CHECK` | Set to `1` to disable update checks and prompts |
|
|
407
|
+
| `NO_UPDATE_NOTIFIER` | Disable update checks and prompts when present |
|
|
408
|
+
| `MOXT_TELEMETRY_DISABLED` | Set to `1` to disable anonymous usage telemetry |
|
|
409
|
+
| `DO_NOT_TRACK` | Set to `1` to disable anonymous usage telemetry (community standard) |
|
|
390
410
|
|
|
391
411
|
## Telemetry
|
|
392
412
|
|
|
@@ -397,17 +417,17 @@ is used, prioritize features, and catch regressions. Telemetry is easy to turn o
|
|
|
397
417
|
|
|
398
418
|
Every invocation of a Moxt CLI command may record:
|
|
399
419
|
|
|
400
|
-
| Field
|
|
401
|
-
|
|
402
|
-
| `command` / `subcommand` | `workspace` / `list`
|
|
403
|
-
| `cli_version`
|
|
404
|
-
| `node_version`
|
|
405
|
-
| `os`
|
|
406
|
-
| `arch`
|
|
407
|
-
| `status`
|
|
408
|
-
| `error_code`
|
|
409
|
-
| `is_ci`
|
|
410
|
-
| Duration
|
|
420
|
+
| Field | Example | Purpose |
|
|
421
|
+
| ------------------------ | ---------------------------- | ----------------------------------------------------------- |
|
|
422
|
+
| `command` / `subcommand` | `workspace` / `list` | Which command was invoked |
|
|
423
|
+
| `cli_version` | `1.2.3` | Distribution of CLI versions in use |
|
|
424
|
+
| `node_version` | `22.13.0` | Minimum-supported runtime planning |
|
|
425
|
+
| `os` | `darwin` / `linux` / `win32` | OS support prioritization |
|
|
426
|
+
| `arch` | `arm64` / `x64` | Architecture support prioritization |
|
|
427
|
+
| `status` | `success` / `error` | Success and error rates |
|
|
428
|
+
| `error_code` | `uncaught_exception` | Error classification (best-effort; may be dropped on crash) |
|
|
429
|
+
| `is_ci` | `true` / `false` | Separate CI traffic from human usage |
|
|
430
|
+
| Duration | `0.42` seconds | Performance tracking |
|
|
411
431
|
|
|
412
432
|
User identification: telemetry is only sent while you are authenticated with a Moxt API
|
|
413
433
|
key. Your **user ID is attached server-side** so that product decisions reflect real
|