@miller-tech/uap 1.50.0 → 1.50.1
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/docs/INDEX.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# UAP Documentation
|
|
2
2
|
|
|
3
|
-
The complete documentation for the **Universal Agent Protocol** (`@miller-tech/uap` v1.
|
|
3
|
+
The complete documentation for the **Universal Agent Protocol** (`@miller-tech/uap` v1.50.0) — a layer that gives AI coding agents memory, judgment, and the discipline to finish the job.
|
|
4
4
|
|
|
5
5
|
New here? Start with the [project README](../README.md), then [Getting Started](getting-started/).
|
|
6
6
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
The Universal Agent Protocol (UAP) is an autonomous AI agent memory system with
|
|
4
4
|
CLAUDE.md protocol enforcement. It ships as a single npm package
|
|
5
|
-
(`@miller-tech/uap`, v1.
|
|
5
|
+
(`@miller-tech/uap`, v1.50.0) that installs the `uap` CLI.
|
|
6
6
|
|
|
7
7
|
## Prerequisites
|
|
8
8
|
|
|
@@ -32,7 +32,7 @@ npm install -g @miller-tech/uap
|
|
|
32
32
|
uap --version
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
This prints the installed package version (e.g. `1.
|
|
35
|
+
This prints the installed package version (e.g. `1.50.0`).
|
|
36
36
|
|
|
37
37
|
## One-command setup
|
|
38
38
|
|
|
@@ -42,8 +42,20 @@ From the root of the project you want to wire up, run:
|
|
|
42
42
|
uap setup
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
`uap setup`
|
|
46
|
-
|
|
45
|
+
`uap setup` is a **guided, arrow-key wizard by default** (powered by
|
|
46
|
+
@clack/prompts). It walks you through the configuration — harnesses, memory
|
|
47
|
+
tiers, coordination, patterns, policies, model provider/profile, hooks — with
|
|
48
|
+
**smart defaults inferred from your environment** (Docker → offer Qdrant; a
|
|
49
|
+
detected local model endpoint → preselect the local provider/profile). Press
|
|
50
|
+
Enter to accept the recommended path. On a non-TTY/CI run, or with
|
|
51
|
+
`--non-interactive`/`-y`, it runs the same flow non-interactively with defaults
|
|
52
|
+
so pipelines never hang on a prompt.
|
|
53
|
+
|
|
54
|
+
Before it changes anything, setup **backs up your existing agent instruction
|
|
55
|
+
files** (`CLAUDE.md`, `AGENTS.md`, `.cursorrules`, …, plus `.uap.json`) to
|
|
56
|
+
`.uap-backups/<date>/`, and offers to **extract your unique custom instructions
|
|
57
|
+
into reusable UAP policies and skills** (see below). It then chains the
|
|
58
|
+
individual commands so the whole system "just works", running these steps:
|
|
47
59
|
|
|
48
60
|
0. **Self-update the CLI** — before anything else, `setup` checks npm and
|
|
49
61
|
**auto-updates the globally-installed `uap` to the latest published version**
|
|
@@ -76,14 +88,38 @@ runs the following steps in order:
|
|
|
76
88
|
### Useful `uap setup` flags
|
|
77
89
|
|
|
78
90
|
```bash
|
|
79
|
-
uap setup
|
|
80
|
-
uap setup --
|
|
81
|
-
uap setup --no-
|
|
82
|
-
uap setup -
|
|
83
|
-
uap setup --
|
|
84
|
-
uap setup -
|
|
91
|
+
uap setup # guided arrow-key wizard (default)
|
|
92
|
+
uap setup --non-interactive # scripted run with defaults (also -y); auto on CI/non-TTY
|
|
93
|
+
uap setup --no-backup # do not back up instruction files first
|
|
94
|
+
uap setup --no-extract # skip custom-content extraction
|
|
95
|
+
uap setup --extract-auto # (scripted mode) auto-extract instead of report-only
|
|
96
|
+
uap setup --no-memory # init only, skip Qdrant/memory services
|
|
97
|
+
uap setup --no-patterns # skip pattern RAG setup and indexing
|
|
98
|
+
uap setup --no-self-update # do not auto-update the global CLI
|
|
99
|
+
uap setup -d <path> # set up a project directory other than the cwd
|
|
85
100
|
```
|
|
86
101
|
|
|
102
|
+
### Backup & custom-content extraction
|
|
103
|
+
|
|
104
|
+
Every `uap setup` first copies your agent instruction files — `CLAUDE.md`,
|
|
105
|
+
`AGENTS.md`, `AGENT.md`, `GEMINI.md`, `.cursorrules`, `.clinerules`,
|
|
106
|
+
`.windsurfrules`, and `.uap.json` — to `.uap-backups/<date>/` (idempotent, gitignored)
|
|
107
|
+
so a run is always reversible. Disable with `--no-backup`.
|
|
108
|
+
|
|
109
|
+
It then detects **non-standard sections** in those files (anything beyond the UAP
|
|
110
|
+
scaffolding) and offers to promote each into a reusable UAP artifact:
|
|
111
|
+
|
|
112
|
+
- imperative rules/gates (e.g. "MUST never commit secrets") → a **policy** under
|
|
113
|
+
`policies/<slug>.md` (registered with the policy engine);
|
|
114
|
+
- workflows/how-tos (e.g. "How to deploy") → a **skill** under
|
|
115
|
+
`skills/<name>/SKILL.md`.
|
|
116
|
+
|
|
117
|
+
In the wizard you confirm/redirect each section; in scripted mode it is
|
|
118
|
+
report-only unless you pass `--extract-auto`. Extraction is deterministic (no
|
|
119
|
+
model calls), idempotent (it won't re-extract a section it already promoted), and
|
|
120
|
+
never overwrites existing files. See **[Policies](../guides/POLICIES.md)** and
|
|
121
|
+
`uap skill list`.
|
|
122
|
+
|
|
87
123
|
### Init only
|
|
88
124
|
|
|
89
125
|
If you only want the project scaffold (config, directories, `CLAUDE.md`) without
|
|
@@ -143,6 +143,27 @@ Install UAP (`npm i -g universal-agent-protocol`) and every feature below activa
|
|
|
143
143
|
|
|
144
144
|
**Why it matters:** Install once; every subsequent setup self-applies the latest behaviour without a manual `npm install -g`. The update takes effect on the next `uap` invocation.
|
|
145
145
|
|
|
146
|
+
### Guided Setup Wizard
|
|
147
|
+
**What it does:** `uap setup` is an arrow-key wizard (by default) that walks you through harnesses, memory tiers, coordination, patterns, policies, model provider/profile, and hooks, then persists the choices to `.uap.json`.
|
|
148
|
+
|
|
149
|
+
**When it kicks in:** Any interactive `uap setup`. On CI / non-TTY (or with `--non-interactive`/`-y`) it runs the same flow non-interactively with smart defaults, so pipelines never hang. Defaults are inferred from the environment (Docker → offer Qdrant; a detected local model endpoint → preselect local provider/profile).
|
|
150
|
+
|
|
151
|
+
**Why it matters:** One guided command lands an optimal configuration instead of remembering a dozen flags — and the same code path runs headless in CI.
|
|
152
|
+
|
|
153
|
+
### Instruction-File Backup on Setup
|
|
154
|
+
**What it does:** Before any merge/rewrite, setup copies your agent instruction files (`CLAUDE.md`, `AGENTS.md`, `.cursorrules`, …, `.uap.json`) to `.uap-backups/<date>/`.
|
|
155
|
+
|
|
156
|
+
**When it kicks in:** First thing in every `uap setup` (and `uap init`). Idempotent and gitignored. Opt out with `--no-backup`.
|
|
157
|
+
|
|
158
|
+
**Why it matters:** A setup run is always reversible — your hand-written instructions are never silently overwritten.
|
|
159
|
+
|
|
160
|
+
### Custom-Content Extraction → Policies & Skills
|
|
161
|
+
**What it does:** Setup detects non-standard sections in your instruction files and promotes them into reusable UAP artifacts — imperative rules/gates become **policies** (`policies/<slug>.md`), workflows become **skills** (`skills/<name>/SKILL.md`).
|
|
162
|
+
|
|
163
|
+
**When it kicks in:** Interactively in the wizard (confirm/redirect each); report-only in scripted mode unless `--extract-auto`. Deterministic (no model calls), idempotent, never overwrites. Opt out with `--no-extract`.
|
|
164
|
+
|
|
165
|
+
**Why it matters:** Your project's bespoke rules and how-tos become first-class, enforceable/loadable UAP artifacts instead of free-text buried in CLAUDE.md.
|
|
166
|
+
|
|
146
167
|
---
|
|
147
168
|
|
|
148
169
|
## Local Model Setup
|
package/docs/reference/CLI.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# UAP CLI Reference
|
|
2
2
|
|
|
3
3
|
> Complete command reference for the Universal Agent Protocol command-line interface (`uap`).
|
|
4
|
-
> Version v1.
|
|
4
|
+
> Version v1.50.0.
|
|
5
5
|
|
|
6
6
|
The `uap` binary is the single entry point for every UAP capability: project
|
|
7
7
|
initialization, the tiered memory system, git worktree workflow, multi-agent
|
|
@@ -85,8 +85,10 @@ uap init --web --no-worktrees
|
|
|
85
85
|
|
|
86
86
|
## `setup`
|
|
87
87
|
|
|
88
|
-
|
|
89
|
-
|
|
88
|
+
Guided one-command setup: a **default arrow-key wizard** (init + start Qdrant +
|
|
89
|
+
Python deps + pattern index) that backs up agent instruction files and extracts
|
|
90
|
+
custom content into policies/skills. Runs the scripted path on CI / non-TTY or
|
|
91
|
+
with `--non-interactive`.
|
|
90
92
|
|
|
91
93
|
```bash
|
|
92
94
|
uap setup [options]
|
|
@@ -95,25 +97,35 @@ uap setup [options]
|
|
|
95
97
|
| Flag | Purpose |
|
|
96
98
|
|------|---------|
|
|
97
99
|
| `-p, --platform <platforms...>` | Targets: `claude`, `factory`, `vscode`, `opencode`, `omp`, `cline`, `codex`, `aider`, `continue`, `windsurf`, `zed`, `copilot`, `jetbrains`, `swe-agent`, `all` (default `all`) |
|
|
100
|
+
| `--non-interactive` | Run the scripted (non-guided) setup; also automatic on CI / non-TTY |
|
|
101
|
+
| `-y, --yes` | Alias for `--non-interactive` (accept defaults, no prompts) |
|
|
102
|
+
| `--no-backup` | Do not back up agent instruction files before modifying them |
|
|
103
|
+
| `--no-extract` | Do not detect/extract custom instruction content into policies/skills |
|
|
104
|
+
| `--extract-auto` | In scripted mode, auto-extract custom content (default: report only) |
|
|
98
105
|
| `--no-patterns` | Skip pattern RAG setup |
|
|
99
106
|
| `--no-memory` | Skip memory system setup |
|
|
100
107
|
| `--no-self-update` | Skip the automatic UAP CLI version check / self-update (also `UAP_NO_SELF_UPDATE=1`) |
|
|
101
108
|
| `--systemd-services` | Scaffold user systemd services for llama.cpp + anthropic proxy |
|
|
102
109
|
| `-d, --project-dir <path>` | Target project directory (defaults to cwd) |
|
|
103
|
-
| `-i, --interactive` | Run the
|
|
110
|
+
| `-i, --interactive` | Run the guided wizard (now the default; kept for back-compat) |
|
|
104
111
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
+
The guided wizard (default) prompts for harnesses, memory tiers, coordination,
|
|
113
|
+
patterns, policies, model provider/profile, hooks, and browser — with smart
|
|
114
|
+
defaults from the environment — and persists the choices to `.uap.json`. Before
|
|
115
|
+
any change it backs up agent instruction files to `.uap-backups/<date>/` and
|
|
116
|
+
offers to extract custom sections into UAP policies/skills (see
|
|
117
|
+
[Installation → Backup & custom-content extraction](../getting-started/INSTALLATION.md#backup--custom-content-extraction)).
|
|
118
|
+
|
|
119
|
+
Setup also ensures the **globally-installed UAP CLI is at the latest published
|
|
120
|
+
npm version** (self-update): non-fatal, global-install-only, downgrade-proof, and
|
|
121
|
+
**skipped in CI** (`UAP_SELF_UPDATE=1` forces it). Disable with
|
|
122
|
+
`--no-self-update` / `UAP_NO_SELF_UPDATE=1`.
|
|
112
123
|
|
|
113
124
|
```bash
|
|
114
|
-
uap setup -
|
|
125
|
+
uap setup # guided arrow-key wizard
|
|
126
|
+
uap setup --non-interactive # scripted (CI-safe); also -y
|
|
115
127
|
uap setup -p claude -d ~/projects/myapp
|
|
116
|
-
uap setup --no-self-update
|
|
128
|
+
uap setup --no-self-update # configure without touching the global CLI
|
|
117
129
|
```
|
|
118
130
|
|
|
119
131
|
---
|
package/package.json
CHANGED
|
Binary file
|