@ogment-ai/cli 0.7.1 → 0.8.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,59 @@
1
+ # Ogment CLI
2
+
3
+ Agent-first CLI for discovering and invoking Ogment-backed tools.
4
+
5
+ - Package: `@ogment-ai/cli`
6
+ - Binary: `ogment`
7
+ - Homepage: <https://ogment.ai/cli>
8
+
9
+ ## Install
10
+
11
+ ```bash
12
+ npm install -g @ogment-ai/cli
13
+ ```
14
+
15
+ ## Quick Start
16
+
17
+ ```bash
18
+ # 1) Authenticate (device flow by default)
19
+ ogment auth login
20
+
21
+ # 2) Discover servers
22
+ ogment catalog
23
+
24
+ # 3) Discover tools on one server
25
+ ogment catalog <server-id>
26
+
27
+ # 4) Inspect one tool schema
28
+ ogment catalog <server-id> <tool-name> --example
29
+
30
+ # 5) Invoke
31
+ ogment invoke <server-id> <tool-name> --input '{}'
32
+ ```
33
+
34
+ ## Common Commands
35
+
36
+ ```bash
37
+ ogment auth login
38
+ ogment auth status
39
+ ogment auth logout
40
+
41
+ ogment catalog [server-id] [tool-name]
42
+
43
+ ogment invoke <server-id> <tool-name> --input '{}'
44
+ ogment status
45
+ ```
46
+
47
+ ## Global Options
48
+
49
+ - `--api-key <key>` API key override
50
+ - `--debug` Include debug metadata and diagnostics in JSON output
51
+ - `--quiet` Emit minimal JSON output (`ok` + `data`/`error`)
52
+
53
+ ## Environment Variables
54
+
55
+ - `OGMENT_API_KEY` (optional API key fallback)
56
+
57
+ ## License
58
+
59
+ MIT