Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions components.lock.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
"state": "resolved",
"cli": {
"repository": "screenrig/cli",
"commit": "79a60d2e42c6d90f4bfb8e91ad25c054cbf1f892",
"commit": "6b85d88e478b827cb3d8ba453a17625ff14b74ca",
"artifact": {
"file": "screenrig-cli.tgz",
"sha256": "9ca9f62cb91b755fe419bb32e86d5904943a9ac54a60bbc2fadea04bd2154a6a"
"sha256": "bee8279b52401f006c0b69fae8b7aaace1ae7b6764d425d81c83b2069c25dc9c"
}
}
}
31 changes: 31 additions & 0 deletions plugins/screenrig/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,39 @@ Commands return JSON envelopes an agent can branch on. Customer surface is
content (`app`, `media`, `compose`), playlists, and screens. Full reference:
[https://screenrig.ai/docs/cli.md](https://screenrig.ai/docs/cli.md).

Discover commands progressively with `screenrig --help`, `screenrig screen --help`,
and `screenrig screen assign --help`. Deeper groups work the same way:
`screenrig comment show --help`. `screenrig help screen assign` is equivalent.
Add `--json` for structured child command paths, invocation syntax, and option types;
help runs without configuration or authentication. Command-specific options follow
that command, for example `screenrig screen update ID --name Lobby --if-match 1`.
Global options such as `--json` may appear before or after the command. Use
`--name=VALUE` for a value starting with a dash, and `--` before option-like file
names. Duplicate options are rejected.

Choose by what the page is:

- Already have the file: `media upload`, then a playlist and `screen assign`.
- Anything presentable: `media generate` as the whole page.
- Slide-deck-like experiences: local unbilled `compose render`.
- Live video, iframe, or webapp: write playlist primitives.

## Application command results

`app upload` and `app update` return the same JSON data paths with or without
`--no-wait`: `data.application` contains the accepted application `id`,
`release_id`, and `operation_id`; `data.pack` contains `sha256` and `file_count`.
The accepted response does not include an application revision. Read `app show`
for the current revision before an update.

`data.operation` contains the observed completed operation when waiting. With
`--no-wait` it is `null`: upload acceptance does not establish operation state
or release readiness. Use `operations get <operation_id>` or
`operations wait <operation_id>` to observe processing. The envelope's
`operation_id` identifies that same operation in either mode. Existing flat
accepted fields (`data.id`, `data.release_id`, `data.operation_id`) and
`data.sha256` remain available as compatibility aliases in both modes.

## Configuration

User-private config lives outside the replaceable plugin directory
Expand All @@ -53,6 +79,11 @@ command.

## Develop

Commander 14 owns argument parsing, command selection, and help rendering while
supporting Node 20.11. The command tree feeds both human and JSON help. The adapter
keeps parser diagnostics inside the CLI error envelope and only forwards explicit
options to handlers, including the existing `no-*` boolean flags.

```sh
npm ci
npm run vendor:check
Expand Down
2 changes: 2 additions & 0 deletions plugins/screenrig/cli/dist/argv.d.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import { type HelpDocument } from "./help.js";
export interface ParsedArgs {
command: string[];
flags: Record<string, string | boolean>;
positionals: string[];
help?: HelpDocument;
}
export declare function parseArgv(argv: string[]): ParsedArgs;
export declare function flagString(flags: Record<string, string | boolean>, name: string): string | undefined;
Expand Down
2 changes: 1 addition & 1 deletion plugins/screenrig/cli/dist/argv.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

162 changes: 36 additions & 126 deletions plugins/screenrig/cli/dist/argv.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion plugins/screenrig/cli/dist/argv.js.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions plugins/screenrig/cli/dist/command-spec.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/** Declarative command inputs for the Commander tree. */
export interface CommandSpec {
readonly path: readonly string[];
readonly arguments?: string;
readonly aliases?: readonly (readonly string[])[];
readonly flags: readonly string[];
readonly requiredFlags?: readonly string[];
}
export declare const GLOBAL_FLAGS: readonly ["json", "api-url", "config", "request-id", "idempotency-key", "timeout", "beta-key", "token"];
export declare const COMMAND_SPECS: readonly CommandSpec[];
//# sourceMappingURL=command-spec.d.ts.map
1 change: 1 addition & 0 deletions plugins/screenrig/cli/dist/command-spec.d.ts.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading