wehub-resource-sync
a789495a98
FreeBSD Smoke / FreeBSD Smoke (x86_64) (push) Has been cancelled
CI / Quality Guardrails (push) Has been cancelled
CI / Build & Test (macos-latest) (push) Has been cancelled
CI / Build & Test (ubuntu-latest) (push) Has been cancelled
CI / Build & Test (windows-latest) (push) Has been cancelled
CI / Format (push) Has been cancelled
CI / PowerShell Syntax (push) Has been cancelled
CI / Windows Cross-Target Check (Linux) (push) Has been cancelled
135 lines
2.6 KiB
Markdown
135 lines
2.6 KiB
Markdown
# jcode wrapper / scripting guide
|
|
|
|
This document describes the non-interactive CLI surface intended for wrappers, scripts, and other tools that invoke `jcode`.
|
|
|
|
## Recommended flags
|
|
|
|
Use these flags by default in wrappers:
|
|
|
|
```bash
|
|
jcode --quiet --no-update --no-selfdev ...
|
|
```
|
|
|
|
- `--quiet` suppresses non-error CLI/status chatter
|
|
- `--no-update` avoids update-check noise/work
|
|
- `--no-selfdev` avoids repository auto-detection changing runtime behavior
|
|
|
|
## Discover available models
|
|
|
|
List model names that can be passed to `-m/--model`:
|
|
|
|
```bash
|
|
jcode --quiet model list
|
|
jcode --quiet model list --json
|
|
jcode --quiet --provider openai model list --json
|
|
```
|
|
|
|
## Discover providers and current selection
|
|
|
|
List provider IDs you can pass to `-p/--provider`:
|
|
|
|
```bash
|
|
jcode --quiet provider list
|
|
jcode --quiet provider list --json
|
|
```
|
|
|
|
Inspect the currently requested and resolved provider/model selection:
|
|
|
|
```bash
|
|
jcode --quiet provider current
|
|
jcode --quiet --provider openai --model gpt-5.4 provider current --json
|
|
```
|
|
|
|
Verbose human summary:
|
|
|
|
```bash
|
|
jcode --quiet model list --verbose
|
|
```
|
|
|
|
## Run one prompt and return JSON
|
|
|
|
```bash
|
|
jcode --quiet run --json "Reply with exactly OK"
|
|
```
|
|
|
|
## Stream one prompt as NDJSON
|
|
|
|
```bash
|
|
jcode --quiet run --ndjson "Reply with exactly OK"
|
|
```
|
|
|
|
Typical event types:
|
|
|
|
- `start`
|
|
- `connection_phase`
|
|
- `connection_type`
|
|
- `text_delta`
|
|
- `text_replace`
|
|
- `tool_start`
|
|
- `tool_input`
|
|
- `tool_exec`
|
|
- `tool_done`
|
|
- `tokens`
|
|
- `done`
|
|
- `error`
|
|
|
|
The final `done` event includes the assembled text and usage summary.
|
|
|
|
Example shape:
|
|
|
|
```json
|
|
{
|
|
"session_id": "session_...",
|
|
"provider": "OpenAI",
|
|
"model": "gpt-5.4",
|
|
"text": "OK",
|
|
"usage": {
|
|
"input_tokens": 123,
|
|
"output_tokens": 7,
|
|
"cache_read_input_tokens": 0,
|
|
"cache_creation_input_tokens": null
|
|
}
|
|
}
|
|
```
|
|
|
|
## Inspect authentication state
|
|
|
|
```bash
|
|
jcode --quiet auth status
|
|
jcode --quiet auth status --json
|
|
```
|
|
|
|
JSON output includes:
|
|
|
|
- `any_available`
|
|
- `providers[]`
|
|
- `id`
|
|
- `display_name`
|
|
- `status`
|
|
- `method`
|
|
- `auth_kind`
|
|
- `recommended`
|
|
|
|
## Inspect build/version details
|
|
|
|
```bash
|
|
jcode --quiet version
|
|
jcode --quiet version --json
|
|
```
|
|
|
|
JSON output includes:
|
|
|
|
- `version`
|
|
- `git_hash`
|
|
- `git_tag`
|
|
- `build_time`
|
|
- `git_date`
|
|
- `release_build`
|
|
|
|
## Notes
|
|
|
|
- JSON commands are designed so the intended machine-readable result is printed to `stdout`
|
|
- With `--quiet`, wrapper-oriented commands should keep `stderr` empty unless there is a real warning/error
|
|
- `jcode model list` and `jcode run --json` do not require the TUI
|
|
- `jcode model list` does not require an already-running shared server
|