@open-agent-toolkit/cli 0.3.13 → 0.3.15
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 +1 -1
- package/assets/bundle-metadata.json +1 -1
- package/assets/docs/contributing/index.md +14 -1
- package/assets/docs/contributing/markdown-features.md +38 -0
- package/assets/docs/contributing/skills.md +64 -2
- package/assets/docs/contributing/smoke-testing.md +23 -16
- package/assets/docs/contributing/updating-model-guidance.md +2 -2
- package/assets/docs/contributing/verifying-cursor-pins.md +1 -1
- package/assets/docs/docs-tooling/add-docs-to-a-repo.md +32 -0
- package/assets/docs/docs-tooling/agent-instructions.md +131 -0
- package/assets/docs/docs-tooling/index.md +1 -0
- package/assets/docs/docs-tooling/meta.json +1 -1
- package/assets/docs/docs-tooling/workflows.md +338 -2
- package/assets/docs/{cli-utilities → getting-started}/bootstrap.md +60 -5
- package/assets/docs/getting-started/concepts.md +120 -0
- package/assets/docs/getting-started/index.md +68 -0
- package/assets/docs/getting-started/meta.json +4 -0
- package/assets/docs/getting-started/quickstart.md +174 -0
- package/assets/docs/{cli-utilities → getting-started}/tool-packs.md +142 -14
- package/assets/docs/index.md +47 -48
- package/assets/docs/meta.json +6 -7
- package/assets/docs/provider-sync/commands.md +25 -2
- package/assets/docs/provider-sync/config.md +60 -1
- package/assets/docs/provider-sync/index.md +31 -15
- package/assets/docs/provider-sync/instruction-sync.md +32 -1
- package/assets/docs/provider-sync/manifest-and-drift.md +92 -0
- package/assets/docs/provider-sync/meta.json +1 -0
- package/assets/docs/provider-sync/pilot-with-a-team.md +236 -0
- package/assets/docs/provider-sync/scope-and-surface.md +37 -3
- package/assets/docs/reference/cli-reference.md +33 -33
- package/assets/docs/{cli-utilities → reference}/config-and-local-state.md +25 -9
- package/assets/docs/{cli-utilities → reference}/configuration.md +151 -34
- package/assets/docs/reference/file-locations.md +4 -1
- package/assets/docs/reference/index.md +13 -1
- package/assets/docs/reference/meta.json +7 -1
- package/assets/docs/reference/oat-directory-structure.md +1 -1
- package/assets/docs/{workflows/projects/artifacts.md → reference/project-artifacts.md} +4 -4
- package/assets/docs/{workflows/projects/state-machine.md → reference/project-state-machine.md} +28 -21
- package/assets/docs/{workflows/projects/repo-analysis.md → reference/repository-pr-comments.md} +2 -2
- package/assets/docs/reference/troubleshooting.md +125 -10
- package/assets/docs/reference/what-oat-writes.md +410 -0
- package/assets/docs/skills/brainstorm.md +77 -0
- package/assets/docs/skills/diagnostics.md +56 -0
- package/assets/docs/{workflows/skills → skills}/explainer-kit.md +121 -0
- package/assets/docs/skills/index.md +416 -0
- package/assets/docs/{workflows/skills → skills}/meta.json +4 -2
- package/assets/docs/{workflows/skills → skills}/recon.md +49 -0
- package/assets/docs/skills/repo-improve.md +254 -0
- package/assets/docs/skills/research.md +237 -0
- package/assets/docs/skills/session-closeout.md +61 -0
- package/assets/docs/workflows/advanced/autonomy.md +344 -0
- package/assets/docs/workflows/{projects → advanced}/cursor-cloud.md +69 -1
- package/assets/docs/workflows/{projects → advanced}/dispatch-ceiling.md +163 -18
- package/assets/docs/workflows/{projects → advanced}/evidence-layers.md +20 -13
- package/assets/docs/workflows/advanced/index.md +19 -0
- package/assets/docs/workflows/advanced/meta.json +13 -0
- package/assets/docs/workflows/{projects → advanced}/orchestration-model.md +108 -35
- package/assets/docs/workflows/{projects → advanced}/programmatic-execution.md +4 -4
- package/assets/docs/{cli-utilities → workflows/advanced}/workflow-gates.md +162 -8
- package/assets/docs/workflows/advanced/worktree-bootstrap.md +83 -0
- package/assets/docs/workflows/approvals-and-automation.md +261 -0
- package/assets/docs/workflows/backlog-and-planning/backlog-lifecycle.md +348 -0
- package/assets/docs/workflows/backlog-and-planning/index.md +13 -0
- package/assets/docs/workflows/backlog-and-planning/meta.json +4 -0
- package/assets/docs/workflows/backlog-and-planning/remote-project-management.md +303 -0
- package/assets/docs/workflows/choose-workflow.md +114 -0
- package/assets/docs/workflows/ideas/index.md +3 -3
- package/assets/docs/workflows/ideas/lifecycle.md +225 -1
- package/assets/docs/workflows/index.md +11 -62
- package/assets/docs/workflows/meta.json +10 -2
- package/assets/docs/workflows/projects/closeout/closeout-skills.md +538 -0
- package/assets/docs/workflows/projects/closeout/index.md +14 -0
- package/assets/docs/workflows/projects/closeout/meta.json +4 -0
- package/assets/docs/workflows/projects/{pr-flow.md → closeout/pr-flow.md} +1 -1
- package/assets/docs/workflows/projects/{retro.md → closeout/retro.md} +1 -1
- package/assets/docs/workflows/projects/execution/execution-skills.md +258 -0
- package/assets/docs/workflows/projects/{implementation-execution.md → execution/implementation-execution.md} +52 -38
- package/assets/docs/workflows/projects/execution/index.md +15 -0
- package/assets/docs/workflows/projects/execution/meta.json +9 -0
- package/assets/docs/workflows/projects/execution/picking-up-projects.md +376 -0
- package/assets/docs/{cli-utilities → workflows/projects/execution}/project-log.md +1 -1
- package/assets/docs/workflows/projects/index.md +38 -49
- package/assets/docs/workflows/projects/lifecycle.md +159 -74
- package/assets/docs/workflows/projects/meta.json +2 -23
- package/assets/docs/workflows/projects/{design-modes.md → planning/design-modes.md} +29 -0
- package/assets/docs/workflows/projects/planning/hill-checkpoints.md +167 -0
- package/assets/docs/workflows/projects/planning/index.md +16 -0
- package/assets/docs/workflows/projects/planning/meta.json +10 -0
- package/assets/docs/workflows/projects/planning/planning-skills.md +381 -0
- package/assets/docs/workflows/projects/{splitting.md → planning/splitting.md} +3 -3
- package/assets/docs/workflows/projects/planning/starting-projects.md +511 -0
- package/assets/docs/workflows/projects/{reviews.md → reviews/index.md} +51 -5
- package/assets/docs/workflows/projects/reviews/meta.json +4 -0
- package/assets/docs/workflows/projects/reviews/review-flavors.md +650 -0
- package/assets/docs/workflows/projects/{reviewing-oat-prs.md → reviews/reviewing-oat-prs.md} +3 -3
- package/assets/docs/workflows/waves/index.md +12 -0
- package/assets/docs/workflows/waves/meta.json +4 -0
- package/assets/docs/workflows/waves/wave-workflows.md +206 -0
- package/assets/public-package-versions.json +4 -4
- package/assets/skills/oat-docs/SKILL.md +19 -19
- package/assets/skills/oat-docs-analyze/SKILL.md +1 -1
- package/assets/skills/oat-docs-apply/SKILL.md +1 -1
- package/assets/skills/oat-docs-authoring/SKILL.md +1 -1
- package/assets/skills/oat-docs-bootstrap/SKILL.md +1 -1
- package/assets/skills/oat-doctor/SKILL.md +25 -25
- package/assets/templates/docs-app-fuma/app/[[...slug]]/page.tsx +14 -2
- package/assets/templates/docs-app-fuma/app/globals.css +1 -0
- package/dist/release/public-package-contract.js +1 -1
- package/package.json +2 -2
- package/assets/docs/cli-utilities/backlog-lifecycle.md +0 -80
- package/assets/docs/cli-utilities/index.md +0 -74
- package/assets/docs/cli-utilities/meta.json +0 -13
- package/assets/docs/cli-utilities/remote-project-management.md +0 -191
- package/assets/docs/guide/concepts.md +0 -88
- package/assets/docs/guide/index.md +0 -31
- package/assets/docs/guide/meta.json +0 -4
- package/assets/docs/quickstart.md +0 -88
- package/assets/docs/workflows/projects/autonomy.md +0 -196
- package/assets/docs/workflows/projects/hill-checkpoints.md +0 -93
- package/assets/docs/workflows/projects/picking-up-projects.md +0 -124
- package/assets/docs/workflows/projects/review-flavors.md +0 -138
- package/assets/docs/workflows/skills/index.md +0 -184
- package/assets/docs/workflows/skills/repo-improve.md +0 -89
- package/assets/docs/workflows/wave-workflows.md +0 -77
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: CLI Utilities
|
|
3
|
-
description: Standalone adoption lane for general OAT CLI surfaces outside provider sync, docs tooling, and tracked workflows.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# CLI Utilities
|
|
7
|
-
|
|
8
|
-
CLI Utilities is the OAT lane for the useful command surface that does not primarily belong to Provider Sync, Docs Tooling, or tracked workflow lifecycle execution.
|
|
9
|
-
|
|
10
|
-
Use this section when you want bootstrap guidance, tool-pack lifecycle details, configuration help, and general-purpose command references. It covers general-purpose setup, configuration, pack-management, and diagnostic utilities that support the rest of the toolkit without being specific to provider sync, docs tooling, or tracked workflow execution.
|
|
11
|
-
|
|
12
|
-
## Contents
|
|
13
|
-
|
|
14
|
-
- [CLI Bootstrap](bootstrap.md) - Foundational `oat init` guidance outside provider-sync-specific onboarding.
|
|
15
|
-
- [Tool Packs and Installed Assets](tool-packs.md) - Bundled packs and `oat tools` lifecycle commands.
|
|
16
|
-
- [Configuration](configuration.md) - OAT configuration guidance across shared, local, user, and provider-sync surfaces.
|
|
17
|
-
- [Remote Project Management](remote-project-management.md) - Provider-neutral remote bindings, policy, previews, approvals, storage, and recovery.
|
|
18
|
-
- [Config and Local State](config-and-local-state.md) - Utility command groups for config, local state, diagnostics, and related inspection flows.
|
|
19
|
-
- [Project Log](project-log.md) - Append-only project observations, synthesis, inspection, and durable roll-up.
|
|
20
|
-
- [Backlog Lifecycle](backlog-lifecycle.md) - Backlog item states, atomic close-out with `oat backlog archive`, and lifecycle drift detection in `oat pjm doctor`.
|
|
21
|
-
- [Workflow Gates](workflow-gates.md) - Completion-safe headless reviews, budgets, liveness evidence, and cross-runtime dispatch with `oat gate`.
|
|
22
|
-
|
|
23
|
-
## What Lives Here
|
|
24
|
-
|
|
25
|
-
This section collects the command groups that help you initialize OAT, manage installed packs, inspect local or config state, and use the wider CLI without implying that you are adopting provider sync or tracked workflows.
|
|
26
|
-
|
|
27
|
-
Examples include:
|
|
28
|
-
|
|
29
|
-
- bootstrap and setup flows such as `oat init`
|
|
30
|
-
- bundled pack management through `oat tools`
|
|
31
|
-
- general configuration guidance
|
|
32
|
-
- workflow gate commands for per-skill final checks and cross-runtime review dispatch
|
|
33
|
-
- utility command groups for config, local state, diagnostics, and related inspection flows
|
|
34
|
-
- a guided health check, the `/oat-doctor` skill, that sweeps config, project management, agent instructions, docs, and installed tools, then explains and offers fixes for what it finds (described in [Config and Local State](config-and-local-state.md))
|
|
35
|
-
|
|
36
|
-
## Who It's For
|
|
37
|
-
|
|
38
|
-
- Users getting OAT set up in a repo
|
|
39
|
-
- Teams managing installed tool packs and local config
|
|
40
|
-
- People who need a general command map without diving into workflow lifecycle docs
|
|
41
|
-
|
|
42
|
-
## When To Use This Section
|
|
43
|
-
|
|
44
|
-
Use CLI Utilities when:
|
|
45
|
-
|
|
46
|
-
- you are first setting up OAT in a repo
|
|
47
|
-
- you need to install or update OAT packs
|
|
48
|
-
- you are looking for configuration or local-state inspection help
|
|
49
|
-
- you need the general CLI surface without committing to one of the deeper lanes yet
|
|
50
|
-
|
|
51
|
-
## Start Here
|
|
52
|
-
|
|
53
|
-
- Use [CLI Bootstrap](bootstrap.md) when you are starting with `oat init`.
|
|
54
|
-
- Go to [Tool Packs](tool-packs.md) when you are managing bundled OAT packs and installed assets.
|
|
55
|
-
- Read [Configuration](configuration.md) for config semantics, or [Config and Local State](config-and-local-state.md) for inspection and diagnostic command groups.
|
|
56
|
-
- Read [Remote Project Management](remote-project-management.md) before binding local planning records to GitHub, Linear, or Jira.
|
|
57
|
-
- Use [Workflow Gates](workflow-gates.md) when you want a skill to run a configured final command before it is considered done.
|
|
58
|
-
|
|
59
|
-
## Common Tasks
|
|
60
|
-
|
|
61
|
-
- Bootstrap OAT in a repo with [CLI Bootstrap](bootstrap.md).
|
|
62
|
-
- Manage installed packs in [Tool Packs](tool-packs.md).
|
|
63
|
-
- Adjust settings in [Configuration](configuration.md).
|
|
64
|
-
- Use [Config and Local State](config-and-local-state.md) for the utility command groups that support inspection and diagnostics.
|
|
65
|
-
- Configure cross-runtime review gates in [Workflow Gates](workflow-gates.md).
|
|
66
|
-
|
|
67
|
-
## Go Deeper
|
|
68
|
-
|
|
69
|
-
- [CLI Bootstrap](bootstrap.md) - Foundational `oat init` guidance outside provider-sync-specific onboarding.
|
|
70
|
-
- [Tool Packs](tool-packs.md) - Bundled packs and `oat tools` lifecycle commands.
|
|
71
|
-
- [Configuration](configuration.md) - OAT configuration guidance.
|
|
72
|
-
- [Remote Project Management](remote-project-management.md) - Safely operate explicit remote planning-record bindings.
|
|
73
|
-
- [Config and Local State](config-and-local-state.md) - Utility command groups for config, local state, diagnostics, and related inspection flows.
|
|
74
|
-
- [Workflow Gates](workflow-gates.md) - Per-skill final commands and cross-runtime review dispatch.
|
|
@@ -1,191 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Remote Project Management
|
|
3
|
-
description: Safely bind OAT planning records to GitHub, Linear, or Jira through provider-neutral host capabilities.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Remote Project Management
|
|
7
|
-
|
|
8
|
-
Remote project management connects an OAT backlog item or project to a remote
|
|
9
|
-
GitHub, Linear, or Jira record. OAT owns policy, previews, approvals, durable
|
|
10
|
-
operation state, and authoritative read-back verification. The host agent owns
|
|
11
|
-
live execution capability discovery.
|
|
12
|
-
|
|
13
|
-
Remote management is deliberately explicit. It does not turn every plan task
|
|
14
|
-
into a remote issue, run background synchronization, or treat a provider result
|
|
15
|
-
as proof of success.
|
|
16
|
-
|
|
17
|
-
## Prerequisite
|
|
18
|
-
|
|
19
|
-
Confirm that file-backed project management is adopted before using a remote
|
|
20
|
-
command:
|
|
21
|
-
|
|
22
|
-
```bash
|
|
23
|
-
oat pjm doctor --json
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
Continue only when `adoption.state` is `declared` or `inferred-legacy`. Run
|
|
27
|
-
`oat pjm init` first when adoption is absent or only partially initialized.
|
|
28
|
-
|
|
29
|
-
## Lifecycle operations
|
|
30
|
-
|
|
31
|
-
The command family is `oat pjm remote`:
|
|
32
|
-
|
|
33
|
-
```bash
|
|
34
|
-
oat pjm remote intake github:example/repository#123 --to-backlog BL-123 --capability-evidence-stdin --json
|
|
35
|
-
oat pjm remote publish --binding rb_example --capability-evidence-stdin --json
|
|
36
|
-
oat pjm remote refresh --binding rb_example --capability-evidence-stdin --json
|
|
37
|
-
oat pjm remote reconcile --binding rb_example --capability-evidence-stdin --json
|
|
38
|
-
oat pjm remote closeout --project .oat/projects/shared/example --capability-evidence-stdin --json
|
|
39
|
-
oat pjm remote discussion --binding rb_example --limit 20 --capability-evidence-stdin --json
|
|
40
|
-
oat pjm remote resolve relink --binding rb_example github:example/repository#456 --capability-evidence-stdin --json
|
|
41
|
-
oat pjm remote resolve detach --binding rb_example --json
|
|
42
|
-
oat pjm remote resolve recreate --binding rb_example --capability-evidence-stdin --json
|
|
43
|
-
oat pjm remote doctor --json
|
|
44
|
-
oat pjm remote migrate --check --json
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
Before each provider-contacting example, the host discovers live capability and
|
|
48
|
-
supplies only its bounded provider-neutral evidence on standard input. Mutation
|
|
49
|
-
commands also require the current caller-owned authority evidence requested by
|
|
50
|
-
their live help.
|
|
51
|
-
|
|
52
|
-
- `intake` reads one remote record into a selected local backlog target and
|
|
53
|
-
creates the binding.
|
|
54
|
-
- `publish` creates or updates one explicitly selected binding.
|
|
55
|
-
- `refresh` updates retained snapshots without writing remotely.
|
|
56
|
-
- `reconcile` classifies local, remote, and baseline changes before proposing
|
|
57
|
-
any write.
|
|
58
|
-
- `closeout` prepares a reviewed batch while preserving independent per-binding
|
|
59
|
-
outcomes.
|
|
60
|
-
- `discussion` returns one bounded, sanitized page as non-persisted evidence.
|
|
61
|
-
- `resolve relink`, `detach`, and `recreate` handle anomalous bindings without
|
|
62
|
-
discarding identity history or retrying an uncertain create blindly.
|
|
63
|
-
- `doctor` and `migrate` diagnose or repair local records without contacting a
|
|
64
|
-
provider.
|
|
65
|
-
|
|
66
|
-
Use `--help` on the live command for current options. JSON output uses one
|
|
67
|
-
versioned envelope and may return a nonzero shell exit for a safely persisted
|
|
68
|
-
`pending`, `needs-review`, `partial`, `uncertain`, or `blocked` outcome.
|
|
69
|
-
|
|
70
|
-
## Repository-owned policy
|
|
71
|
-
|
|
72
|
-
Remote policy lives only in the shared repository config at `.oat/config.json`.
|
|
73
|
-
The safe defaults are local operational state, no description publication, and
|
|
74
|
-
read-only authority:
|
|
75
|
-
|
|
76
|
-
```json
|
|
77
|
-
{
|
|
78
|
-
"pjm": {
|
|
79
|
-
"remote": {
|
|
80
|
-
"schemaVersion": 1,
|
|
81
|
-
"storage": { "state": "local" },
|
|
82
|
-
"policy": {
|
|
83
|
-
"description": "none",
|
|
84
|
-
"authority": { "default": "read-only" }
|
|
85
|
-
}
|
|
86
|
-
}
|
|
87
|
-
}
|
|
88
|
-
}
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
Use the config command instead of editing nested values by hand:
|
|
92
|
-
|
|
93
|
-
```bash
|
|
94
|
-
oat config set pjm.remote.policy.description managed-section --shared
|
|
95
|
-
oat config set pjm.remote.policy.authority.operations.update-fields user-approved --shared
|
|
96
|
-
oat config set pjm.remote.policy.providers.github.authority.operations.create user-approved --shared
|
|
97
|
-
```
|
|
98
|
-
|
|
99
|
-
Description modes are `none`, `managed-section`, and `replace`. Authority modes
|
|
100
|
-
are `read-only`, `user-approved`, `user-authorized`, and `autonomous`.
|
|
101
|
-
For each operation, OAT resolves the repository operation override, then its
|
|
102
|
-
repository default, then the built-in read-only fallback. A matching provider
|
|
103
|
-
operation override or provider default replaces that repository result and may
|
|
104
|
-
broaden it. Binding defaults and operation restrictions then clamp authority,
|
|
105
|
-
while purpose field grants intersect to narrow the outbound fields. Provider
|
|
106
|
-
configuration never bypasses hard approval floors or the requirement for
|
|
107
|
-
current caller-owned authority evidence; missing, stale, or mismatched evidence
|
|
108
|
-
fails closed. Autonomous configuration is not a background grant.
|
|
109
|
-
|
|
110
|
-
## Live host capability boundary
|
|
111
|
-
|
|
112
|
-
At operation time, the host agent inspects currently granted MCP or connector
|
|
113
|
-
descriptions for the requested semantic operation and exact account, workspace,
|
|
114
|
-
site, or repository context. If no capable connector is available, it may
|
|
115
|
-
inspect the live help of an already configured provider CLI before the first
|
|
116
|
-
provider-contacting command.
|
|
117
|
-
|
|
118
|
-
OAT does not store provider tool names, native schemas, captured catalogs,
|
|
119
|
-
executable names, flags, or CLI dialects. The host returns only bounded,
|
|
120
|
-
sanitized capability evidence through `--capability-evidence-stdin`. It must not
|
|
121
|
-
install tools, request credential values, or switch execution surfaces after an
|
|
122
|
-
attempt begins. The CLI may then emit one provider-neutral `externalAction`.
|
|
123
|
-
The host executes that exact action at most once and returns one bounded
|
|
124
|
-
observation with `oat pjm remote operation continue`.
|
|
125
|
-
|
|
126
|
-
## Content and outbound safety
|
|
127
|
-
|
|
128
|
-
Inbound provider text is retained only through an allowlist of core fields and
|
|
129
|
-
adapter-approved extensions. If a retained text field triggers a conservative
|
|
130
|
-
sensitive-content signal, OAT suppresses that whole field and marks the
|
|
131
|
-
snapshot incomplete. This is a bounded field-safety rule, not general DLP or
|
|
132
|
-
credential-value parsing.
|
|
133
|
-
|
|
134
|
-
Every remote create or update consumes only an explicit normalized projection.
|
|
135
|
-
The universal provider-neutral pre-write gate evaluates that projection before
|
|
136
|
-
preview, approval, action, and authoritative read-back. It never scans the
|
|
137
|
-
repository, worktree, Git history, or arbitrary files for secrets. Missing,
|
|
138
|
-
stale, failed, or blocked safety evidence prevents execution.
|
|
139
|
-
|
|
140
|
-
## Previews, approval floors, and uncertainty
|
|
141
|
-
|
|
142
|
-
Mutation-capable commands persist and return a preview before execution. The
|
|
143
|
-
preview digest binds the target, normalized fields, remote revision,
|
|
144
|
-
capability, safety result, and effective policy. If any load-bearing input
|
|
145
|
-
changes, the approval is stale.
|
|
146
|
-
|
|
147
|
-
Fresh approval is always required for complete description replacement,
|
|
148
|
-
relink, detach, recreate, destructive operations, and promotion to shared
|
|
149
|
-
operational storage. `user-approved` authority also requires applying the exact
|
|
150
|
-
persisted preview. Higher configured authority cannot bypass those floors.
|
|
151
|
-
|
|
152
|
-
The host submits a bounded observation with `oat pjm remote operation continue`.
|
|
153
|
-
Only an OAT `ok` envelope after authoritative read-back means success. A
|
|
154
|
-
connector response, process exit, or visible remote change is evidence rather
|
|
155
|
-
than a verdict. If a create or update is uncertain, do not retry it blindly;
|
|
156
|
-
use the recovery guidance in the envelope so OAT can search, relink, recreate,
|
|
157
|
-
or reconcile without producing duplicates.
|
|
158
|
-
|
|
159
|
-
## Storage and worktrees
|
|
160
|
-
|
|
161
|
-
Portable binding metadata follows its backlog or project owner. Shared backlog
|
|
162
|
-
metadata lives under `.oat/repo/pjm/remote/bindings`; project metadata lives
|
|
163
|
-
under that project's `remote/bindings` directory. Local projects keep their
|
|
164
|
-
portable metadata in the local operational store.
|
|
165
|
-
|
|
166
|
-
Operational snapshots, journals, batches, and receipts default to a
|
|
167
|
-
repository-fingerprinted directory under the Git common directory:
|
|
168
|
-
`.git/oat/pjm-remote/<repository-fingerprint>/`. All linked worktrees for one
|
|
169
|
-
repository therefore share the same local operational state, while another
|
|
170
|
-
clone gets its own store.
|
|
171
|
-
|
|
172
|
-
Shared operational storage is opt-in and may expose remote planning content to
|
|
173
|
-
everyone with repository access. It requires a persisted preview and fresh
|
|
174
|
-
approval, and it is rejected for local projects. Preview the exact proposed
|
|
175
|
-
paths through `oat pjm remote storage shared --help` before applying them.
|
|
176
|
-
|
|
177
|
-
## Offline behavior
|
|
178
|
-
|
|
179
|
-
OAT can inspect portable bindings, the bounded local snapshot, journals,
|
|
180
|
-
receipts, and pending recovery instructions while offline. `remote doctor` and
|
|
181
|
-
`migrate` are local-only. Provider refresh, publication, reconciliation writes,
|
|
182
|
-
and authoritative verification remain pending or blocked until matching live
|
|
183
|
-
capability evidence is available; offline state never fabricates remote
|
|
184
|
-
freshness or success.
|
|
185
|
-
|
|
186
|
-
## Related references
|
|
187
|
-
|
|
188
|
-
- [Configuration](configuration.md)
|
|
189
|
-
- [CLI Reference](../reference/cli-reference.md)
|
|
190
|
-
- [File Locations](../reference/file-locations.md)
|
|
191
|
-
- [Troubleshooting](../reference/troubleshooting.md)
|
|
@@ -1,88 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Core Concepts
|
|
3
|
-
description: Mental model for canonical assets, provider views, scopes, skills, and the optional workflow layer.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Core Concepts
|
|
7
|
-
|
|
8
|
-
OAT combines a provider-sync layer, reusable skills and CLI tooling, and an optional workflow system. This page gives the high-level mental model so the detailed docs are easier to navigate.
|
|
9
|
-
|
|
10
|
-
## Capability Stack
|
|
11
|
-
|
|
12
|
-
```mermaid
|
|
13
|
-
flowchart TD
|
|
14
|
-
BASE["Provider sync + CLI\ncanonical assets, status, sync, docs commands"] --> MIDDLE["Reusable skills + tooling\nideas, docs workflows, repo helpers"]
|
|
15
|
-
MIDDLE --> TOP["Optional workflow layer\ntracked projects, reviews, PR flow, HiLL"]
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
## Canonical Assets and Provider Views
|
|
19
|
-
|
|
20
|
-
OAT keeps canonical assets in repo-controlled locations and projects provider-specific views from that source of truth. The canonical form is what you edit and review directly; provider views are synchronized outputs that let Claude Code, Cursor, Copilot, Gemini, and Codex consume the same intent in their native layouts.
|
|
21
|
-
|
|
22
|
-
```mermaid
|
|
23
|
-
flowchart LR
|
|
24
|
-
SKILLS[".agents/skills/"] --> OAT["oat sync"]
|
|
25
|
-
AGENTS[".agents/agents/"] --> OAT
|
|
26
|
-
RULES[".agents/rules/"] --> OAT
|
|
27
|
-
OAT --> CLAUDE[".claude/"]
|
|
28
|
-
OAT --> CURSOR[".cursor/"]
|
|
29
|
-
OAT --> COPILOT[".github/"]
|
|
30
|
-
OAT --> GEMINI[".gemini/"]
|
|
31
|
-
OAT --> CODEX[".codex/"]
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
Use these docs next:
|
|
35
|
-
|
|
36
|
-
- [Provider Sync](../provider-sync/index.md)
|
|
37
|
-
- [Reference](../reference/index.md)
|
|
38
|
-
|
|
39
|
-
## Sync, Drift, and Adoption
|
|
40
|
-
|
|
41
|
-
`oat sync` applies canonical content to provider views, while `oat status` reports whether a provider is in sync, drifted, or missing content. Drift is expected when provider-side files diverge from canonical content; OAT now also covers canonical rule sync and stray adoption so you can bring unmanaged files back under the canonical model deliberately.
|
|
42
|
-
|
|
43
|
-
Use these docs next:
|
|
44
|
-
|
|
45
|
-
- [Provider Sync Commands](../provider-sync/commands.md)
|
|
46
|
-
- [Manifest and Drift](../provider-sync/manifest-and-drift.md)
|
|
47
|
-
|
|
48
|
-
## Scopes
|
|
49
|
-
|
|
50
|
-
Most OAT operations run in one of three scopes: `project`, `user`, or `all`. Project scope targets the current repository, user scope targets user-level installations, and `all` evaluates both. The same scope model appears across sync, status, and provider configuration commands, so it is worth learning early.
|
|
51
|
-
|
|
52
|
-
Use these docs next:
|
|
53
|
-
|
|
54
|
-
- [Scope and Surface](../provider-sync/scope-and-surface.md)
|
|
55
|
-
- [CLI Reference](../reference/cli-reference.md)
|
|
56
|
-
|
|
57
|
-
## Skills and CLI Commands
|
|
58
|
-
|
|
59
|
-
Skills are structured workflow instructions stored in `.agents/skills`, while CLI commands provide direct operational entry points like `oat init`, `oat sync`, or `oat docs init`. Some capabilities are primarily CLI-driven, some are primarily skill-driven, and some combine both. As a rule: use the CLI for direct system actions and use skills when you want guided lifecycle execution.
|
|
60
|
-
|
|
61
|
-
Use these docs next:
|
|
62
|
-
|
|
63
|
-
- [Skills](../workflows/skills/index.md)
|
|
64
|
-
- [Contributing Skills](../contributing/skills.md)
|
|
65
|
-
|
|
66
|
-
## The Three Usage Modes
|
|
67
|
-
|
|
68
|
-
OAT can be adopted in three layers:
|
|
69
|
-
|
|
70
|
-
1. Provider sync and CLI interop only
|
|
71
|
-
2. Provider-agnostic tooling and reusable skills
|
|
72
|
-
3. Optional workflow/project lifecycle
|
|
73
|
-
|
|
74
|
-
These layers stack. You can stay at the interop layer, use only the tooling layer, or adopt the full lifecycle when you need tracked discovery, planning, implementation, review, and PR flow.
|
|
75
|
-
|
|
76
|
-
Use these docs next:
|
|
77
|
-
|
|
78
|
-
- [Quickstart](../quickstart.md)
|
|
79
|
-
- [Workflow & Projects](../workflows/projects/index.md)
|
|
80
|
-
|
|
81
|
-
## Human-in-the-Loop Lifecycle
|
|
82
|
-
|
|
83
|
-
The workflow system supports explicit checkpoints so a project can pause at selected moments for approval or direction. At the workflow level, HiLL gates control lifecycle routing across discovery, spec, design, plan, and implementation. During implementation, plan-phase checkpoints control where execution pauses between plan phases.
|
|
84
|
-
|
|
85
|
-
Use these docs next:
|
|
86
|
-
|
|
87
|
-
- [Workflow & Projects](../workflows/projects/index.md)
|
|
88
|
-
- [Hill Checkpoints](../workflows/projects/hill-checkpoints.md)
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: User Guide
|
|
3
|
-
description: User-facing guide for operating OAT across provider sync, docs tooling, workflow execution, skills, and ideas.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# User Guide
|
|
7
|
-
|
|
8
|
-
This page is now a compatibility router.
|
|
9
|
-
|
|
10
|
-
The old catch-all User Guide is being split into clearer adoption lanes so new users can choose the part of OAT that matches what they actually need.
|
|
11
|
-
|
|
12
|
-
## Contents
|
|
13
|
-
|
|
14
|
-
- [Core Concepts](concepts.md) - High-level mental model while concept material is being redistributed.
|
|
15
|
-
|
|
16
|
-
## Status
|
|
17
|
-
|
|
18
|
-
This guide bucket remains visible so older links have a stable landing page. New docs should go into the canonical top-level sections below instead of adding more pages under `guide/`.
|
|
19
|
-
|
|
20
|
-
## Canonical Sections
|
|
21
|
-
|
|
22
|
-
- [Provider Sync](../provider-sync/index.md) - Provider interoperability, drift, sync, and config behavior.
|
|
23
|
-
- [Agentic Workflows](../workflows/index.md) - Tracked projects, ideas, workflow skills, and lifecycle execution.
|
|
24
|
-
- [Docs Tooling](../docs-tooling/index.md) - Docs app setup, docs commands, and docs workflow entry points.
|
|
25
|
-
- [CLI Utilities](../cli-utilities/index.md) - Bootstrap, tool packs, configuration, and general CLI surfaces.
|
|
26
|
-
- [Reference](../reference/index.md) - Durable contracts and reference material.
|
|
27
|
-
|
|
28
|
-
## Legacy Pages Still Under Guide
|
|
29
|
-
|
|
30
|
-
- [Core Concepts](concepts.md) - High-level mental model while concept material is being redistributed.
|
|
31
|
-
- This guide bucket is being retired. Use the canonical top-level sections above for active documentation.
|
|
@@ -1,88 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Quickstart
|
|
3
|
-
description: 'Start-here guide for choosing the right OAT adoption path.'
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Quickstart
|
|
7
|
-
|
|
8
|
-
Use this page to choose the OAT path that matches what you are actually trying to do.
|
|
9
|
-
|
|
10
|
-
This page is intentionally lightweight. It is not the full command manual. Once you choose a path, continue into the owning section for the deeper operational detail.
|
|
11
|
-
|
|
12
|
-
## Prerequisites
|
|
13
|
-
|
|
14
|
-
- Node.js 22.17 or newer
|
|
15
|
-
- Git 2.31 or newer
|
|
16
|
-
|
|
17
|
-
OAT does not run an up-front Git version check. Git compatibility is evaluated
|
|
18
|
-
best-effort by each command, and a missing or unsupported Git operation exits as
|
|
19
|
-
a system error.
|
|
20
|
-
|
|
21
|
-
## Choose a Path
|
|
22
|
-
|
|
23
|
-
### Provider Sync
|
|
24
|
-
|
|
25
|
-
Use this path when you want canonical skills, agents, and rules to stay aligned across provider surfaces such as Claude, Cursor, Copilot, Gemini, or Codex.
|
|
26
|
-
|
|
27
|
-
Best fit:
|
|
28
|
-
|
|
29
|
-
- you want cross-provider sync and drift checks
|
|
30
|
-
- you care about canonical-to-provider asset management
|
|
31
|
-
- you do not necessarily need tracked project workflows
|
|
32
|
-
|
|
33
|
-
Continue here:
|
|
34
|
-
|
|
35
|
-
- [Provider Sync](provider-sync/index.md)
|
|
36
|
-
|
|
37
|
-
### Agentic Workflows
|
|
38
|
-
|
|
39
|
-
Use this path when you want tracked, resumable implementation work with explicit lifecycle artifacts, reviews, and handoff-friendly state.
|
|
40
|
-
|
|
41
|
-
Best fit:
|
|
42
|
-
|
|
43
|
-
- you want structured project execution
|
|
44
|
-
- you want lifecycle artifacts like `state.md`, `plan.md`, and `implementation.md`
|
|
45
|
-
- you want a workflow layer on top of the base CLI/tooling
|
|
46
|
-
|
|
47
|
-
Continue here:
|
|
48
|
-
|
|
49
|
-
- [Agentic Workflows](workflows/index.md)
|
|
50
|
-
|
|
51
|
-
### Docs Tooling
|
|
52
|
-
|
|
53
|
-
Use this path when you are bootstrapping or maintaining a documentation surface with OAT.
|
|
54
|
-
|
|
55
|
-
Best fit:
|
|
56
|
-
|
|
57
|
-
- you need docs app setup or maintenance workflows
|
|
58
|
-
- you care about docs navigation, docs commands, and docs-specific analysis/apply flows
|
|
59
|
-
- you want the docs-system contract rather than the broader workflow layer
|
|
60
|
-
|
|
61
|
-
Continue here:
|
|
62
|
-
|
|
63
|
-
- [Docs Tooling](docs-tooling/index.md)
|
|
64
|
-
|
|
65
|
-
### CLI Utilities
|
|
66
|
-
|
|
67
|
-
Use this path when you want general OAT CLI help outside the dedicated provider-sync, workflows, and docs-tooling lanes.
|
|
68
|
-
|
|
69
|
-
Best fit:
|
|
70
|
-
|
|
71
|
-
- you want bootstrap/setup guidance
|
|
72
|
-
- you want tool-pack, configuration, local-state, or utility command guidance
|
|
73
|
-
- you want a general CLI surface map rather than one specific product lane
|
|
74
|
-
|
|
75
|
-
Continue here:
|
|
76
|
-
|
|
77
|
-
- [CLI Utilities](cli-utilities/index.md)
|
|
78
|
-
|
|
79
|
-
## If You Are Unsure
|
|
80
|
-
|
|
81
|
-
Start with the path that best matches the primary thing you need right now.
|
|
82
|
-
|
|
83
|
-
- If you are trying to sync canonical assets across tools, choose Provider Sync.
|
|
84
|
-
- If you are trying to run a tracked implementation workflow, choose Agentic Workflows.
|
|
85
|
-
- If you are working on the docs system itself, choose Docs Tooling.
|
|
86
|
-
- If you mainly need command-line setup or utility guidance, choose CLI Utilities.
|
|
87
|
-
|
|
88
|
-
You can adopt more than one lane over time. OAT is designed so these sections can be used together or independently.
|