Skip to content

Commit bb40841

Browse files
author
codejunkie99
committed
docs: improve documentation
1 parent cdf5272 commit bb40841

26 files changed

Lines changed: 1138 additions & 341 deletions

AGENTS.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@ directly in Rust without wrapping a TypeScript runtime.
55

66
## Project Structure
77

8-
- `crates/agentic-harness/` — Rust SDK: agent app, context, sessions, tools, roles, skills, HTTP handling.
9-
- `crates/agentic-harness-cli/` — Rust CLI: `new`, `build`, `dev`, `run`, `serve`, `manifest`, `add`.
8+
- `crates/agentic-harness/` — Rust SDK: agent app, context, sessions, tools,
9+
roles, skills, HTTP handling.
10+
- `crates/agentic-harness-cli/` — Rust CLI: `new`, `build`, `dev`, `run`,
11+
`serve`, `manifest`, `add`.
1012
- `examples/hello-world/` — Rust example workspace.
1113

1214
## Build And Test
@@ -21,13 +23,19 @@ cargo clippy --workspace -- -D warnings
2123

2224
```bash
2325
cargo run -p agentic-harness-cli -- manifest --workspace examples/hello-world
24-
cargo run -p agentic-harness-cli -- run hello --workspace examples/hello-world --id demo --payload '{"name":"Ada"}'
25-
cargo run -p agentic-harness-cli -- build --workspace examples/hello-world --output ./build
26+
cargo run -p agentic-harness-cli -- run hello \
27+
--workspace examples/hello-world \
28+
--id demo \
29+
--payload '{"name":"Ada"}'
30+
cargo run -p agentic-harness-cli -- build \
31+
--workspace examples/hello-world \
32+
--output ./build
2633
```
2734

2835
## Development Notes
2936

3037
- Do not add TypeScript packages, pnpm workspace files, or Node build steps.
3138
- Keep the Rust SDK and Rust CLI as the primary implementation.
32-
- Prefer tests in `crates/agentic-harness/tests/` and `crates/agentic-harness-cli/tests/`.
39+
- Prefer tests in `crates/agentic-harness/tests/` and
40+
`crates/agentic-harness-cli/tests/`.
3341
- Favor native Rust APIs and direct binaries over generated JavaScript.

CHANGELOG.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@
2121
CLIs as timed out.
2222
- Codex and Claude Code launcher paths now use their real non-interactive
2323
coding-agent modes instead of passing only the brief file path.
24-
- Cursor launcher paths use `cursor agent --print --trust --force` for
25-
headless authoring and coding runs.
24+
- Cursor launcher paths use `cursor agent --print --trust --force` for headless
25+
authoring and coding runs.
2626
- Live LLM launcher output is streamed while still being captured for run
2727
summaries, so long Codex/Claude authoring and coding runs do not appear
2828
frozen.
29-
- `template author --open` validates the generated `./<template>` pack after
30-
the selected LLM exits and reports the template path before returning.
29+
- `template author --open` validates the generated `./<template>` pack after the
30+
selected LLM exits and reports the template path before returning.
3131
- `template author --open --json` now preserves stdout as a single final JSON
3232
object and reports `opened` plus `postOpenValidation` while streaming live LLM
3333
output to stderr.
@@ -41,41 +41,41 @@
4141
check mode so downstream agents can tell where verification actually ran.
4242
- Coding-agent summaries expose parsed JSON `agentResult` separately from raw
4343
stdout, including fields such as `summary` and `generatedPatch`.
44-
- Coding-agent summaries now record files edited by an external coding LLM
45-
under `llm.changedFiles` in JSON and in the Markdown LLM section.
44+
- Coding-agent summaries now record files edited by an external coding LLM under
45+
`llm.changedFiles` in JSON and in the Markdown LLM section.
4646
- `agentic-harness code` now uses an actionable default coding brief in
4747
non-interactive no-prompt runs instead of the vague `Inspect the project`
4848
fallback.
4949
- Dashboard sandbox status now runs the configured sandbox smoke check, so
5050
remote HTTP SessionEnv endpoints report remote readiness instead of local
5151
checkout readiness.
52-
- Local hosting is now a first-class local-only capability:
53-
`setup hosting` writes `.agentic-harness/hosting.toml`, `hosting status
54-
--json` exposes loopback URLs and native HTTP capabilities, `host` starts the
55-
configured server, and the dashboard/TUI show the local hosting path without
56-
introducing a deployment workflow.
52+
- Local hosting is now a first-class local-only capability: `setup hosting`
53+
writes `.agentic-harness/hosting.toml`, `hosting status --json` exposes
54+
loopback URLs and native HTTP capabilities, `host` starts the configured
55+
server, and the dashboard/TUI show the local hosting path without introducing
56+
a deployment workflow.
5757
- TUI-style wizard for coding, templates, LLM authoring setup, sandbox setup,
5858
running agents, and doctor checks, with `tui` and `ui` aliases for the common
5959
entrypoint. Second-level screens show contextual panels for LLM availability,
6060
latest results, template previews, authoring setup, sandbox status/logs,
6161
example manifests, readiness, and next fixes. Option screens preview the exact
6262
workspace-aware command before execution, contextual panel commands honor the
6363
selected `--workspace`, and the sandbox panel shows smoke status plus the
64-
latest log entry. The guided LLM coding shortcut
65-
uses `agentic-harness code --llm auto` so it follows local CLI detection.
66-
Dashboard and coding panels surface the latest coding-run loop status when a
67-
latest summary exists. `wizard`/`tui`/`ui` accept `--workspace <path>` so the
64+
latest log entry. The guided LLM coding shortcut uses
65+
`agentic-harness code --llm auto` so it follows local CLI detection. Dashboard
66+
and coding panels surface the latest coding-run loop status when a latest
67+
summary exists. `wizard`/`tui`/`ui` accept `--workspace <path>` so the
6868
dashboard panels and current-workspace actions target the selected project.
6969
- Template packs, including `template init`, validation, install, preview, and
7070
`new --template` scaffolding, plus `template author --open` for preflighting
7171
LLM readiness before launching the selected tool from the target workspace
7272
with the generated brief and live output. Authoring briefs now include
7373
validate, JSON preview, install, scaffold, and doctor commands plus a local
74-
CLI fallback path for validation when
75-
`agentic-harness` is not on PATH, and `template author --json` exposes the
76-
brief path, open command, and validation commands for software agents and TUI
77-
panels. `template search` and `tpl find` search built-in, workspace, user, and
78-
team template scopes with JSON output for agents.
74+
CLI fallback path for validation when `agentic-harness` is not on PATH, and
75+
`template author --json` exposes the brief path, open command, and validation
76+
commands for software agents and TUI panels. `template search` and `tpl find`
77+
search built-in, workspace, user, and team template scopes with JSON output
78+
for agents.
7979
- Local sandbox setup and local sandbox file/shell operations, plus remote
8080
connector instructions for hosted sandbox providers.
8181
- Release packaging starter artifacts: local install script, Homebrew formula,

0 commit comments

Comments
 (0)