@overaihq/cli 0.1.0 → 0.2.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 CHANGED
@@ -12,17 +12,18 @@ npm install -g @overaihq/cli # or: pnpm add -g @overaihq/cli
12
12
  overai update # later, update a global install in place
13
13
  ```
14
14
 
15
- Requires Node.js 22+.
16
-
17
15
  ## Quick start
18
16
 
19
17
  ```sh
20
- overai signin # browser sign-in
18
+ overai signin # browser sign-in; choose your organization for SSO
19
+ overai workspace list # find a workspace id
21
20
  overai clone <workspaceId> # materialize a workspace as files
22
21
  # ...edit files...
23
22
  overai status # local edits + remote drift
24
23
  overai diff # what changed
25
24
  overai review # validation + best-practice review packet
25
+ overai report bug "<details>" # report broken or unexplained behavior
26
+ overai report feature "<details>" # request a missing platform capability
26
27
  overai push -m "why" # create new versions (not live yet)
27
28
  overai deploy # make the pushed versions live
28
29
  ```
@@ -32,6 +33,22 @@ Run `overai help` for the full command list, including function invocation,
32
33
  automation runs and per-node state, tablespace SQL (a psql-style REPL), and
33
34
  `overai dev` for live-previewing a web page from local files.
34
35
 
36
+ ## Passing queries, JSON, and scripts
37
+
38
+ Arguments that carry a whole document rather than a scalar also accept `@<file>`
39
+ to read it from disk, or `@-` to read it from stdin:
40
+
41
+ ```sh
42
+ overai graphql -q @mutation.graphql --variables @vars.json
43
+ overai sql <tableSpaceId> @report.sql
44
+ overai runner run <runnerId> --interpreter powershell --code @collect.ps1
45
+ ```
46
+
47
+ Prefer this for anything long or quote-heavy. An inline value is parsed by your
48
+ shell first, and a single apostrophe inside it closes the quoting — the rest of
49
+ the blob is then read as shell source, which mangles it silently. Write `@@` to
50
+ send a literal value that starts with `@`.
51
+
35
52
  ## For AI agents
36
53
 
37
54
  The CLI bundles its own guidance — no extra setup files needed. Point your
@@ -41,3 +58,8 @@ agent at a cloned workspace and have it run:
41
58
  overai best-practices # platform + per-resource-type guides
42
59
  overai review # before every push
43
60
  ```
61
+
62
+ When platform behavior blocks progress, agents can send detailed feedback with
63
+ `overai report bug -` or `overai report feature -` and the report body on stdin.
64
+ Reports include CLI, runtime, organization, and cloned-workspace identifiers,
65
+ but never files, diffs, environment variables, paths, or command history.