@schmitech/orbit-cli 0.1.0

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 ADDED
@@ -0,0 +1,65 @@
1
+ # orbit-cli
2
+
3
+ Terminal REPL client for ORBIT. See `docs/roadmap/orbit-cli-repl.md` at the
4
+ repo root for the phased plan.
5
+
6
+ ## Status
7
+
8
+ Phases 0–3 are done: connection/`--health`, one-shot mode, the REPL, and
9
+ agents/models/`@` attachments/artifacts/markdown rendering.
10
+
11
+ ## Usage
12
+
13
+ ```bash
14
+ npm install
15
+ npm run build
16
+
17
+ # --url defaults to http://localhost:3000 if omitted (flag/env/prompt all fall back to it):
18
+ node bin/orbit-chat.js --key sk-... --health
19
+
20
+ # Flags:
21
+ node bin/orbit-chat.js --url http://localhost:3000 --key sk-... --health
22
+
23
+ # Or via env (preferred — a --key flag lands in shell history):
24
+ export ORBIT_URL=http://localhost:3000
25
+ export ORBIT_API_KEY=sk-...
26
+ node bin/orbit-chat.js --health
27
+
28
+ # One-shot mode: send a single message and print the reply to stdout.
29
+ node bin/orbit-chat.js "What is the capital of France?"
30
+
31
+ # Read the message from stdin instead:
32
+ echo "Summarize this." | node bin/orbit-chat.js -
33
+
34
+ # Pick an agent (skill) or model for this turn:
35
+ node bin/orbit-chat.js --agent <skill-name> --model <model-id> "hi"
36
+
37
+ # Plain text out, no ANSI — safe to pipe:
38
+ node bin/orbit-chat.js "hi" | cat
39
+
40
+ # Ctrl+C cancels an in-flight one-shot turn (exit code 130).
41
+
42
+ # Interactive REPL: no message, run from a real terminal.
43
+ node bin/orbit-chat.js
44
+
45
+ # In the REPL:
46
+ # type a message and press Enter to send a turn
47
+ # /new start a new session
48
+ # /agents list agents (the key's own adapter + enabled skills)
49
+ # /agents <name|#> switch agent — clears any /model selection
50
+ # /models list models allowed for the current agent
51
+ # /model <id|#> set the model for later turns
52
+ # /key <api-key> switch API key without restarting (re-discovers agents)
53
+ # /clear clear the screen
54
+ # /help list commands
55
+ # /exit exit
56
+ # Ctrl+C cancel the in-flight turn; again while idle to exit
57
+ # Ctrl+D exit
58
+ #
59
+ # @path/to/file inline in a message attaches that file to the turn (works in
60
+ # both the REPL, with tab completion, and one-shot mode). Generated media
61
+ # (images, video, documents, TTS audio) is written to ./.orbit-out/.
62
+ ```
63
+
64
+ Exit codes: `0` ok, `1` server error, `2` usage, `3` auth, `4` network,
65
+ `130` cancelled.
@@ -0,0 +1,2 @@
1
+ #!/usr/bin/env node
2
+ import '../dist/cli.js';