Copy page View as Markdown

Use the command line

Run these commands from your project root after installing Core. The examples use uvx; change the prefix if you chose a tool or project installation.

Find your work

Command

uvx vaultspec-core status
uvx vaultspec-core vault feature list

Status shows plans in flight and recent records. The feature list also finds work that has records but no plan.

To list records for the quickstart’s feature:

Command

uvx vaultspec-core vault list --feature notes-search

Feature-specific status needs a plan to trace. Before a plan exists, status notes-search exits 1 with an unresolved target, so use the record list until then.

Create a record

If you haven’t created the quickstart record yet, run:

Command

uvx vaultspec-core vault add research --feature notes-search --title "Search project notes"

Open the path printed after Created:. The command supplies the filename and metadata; you or your agent must fill in the research. It does not investigate the subject or implement code.

Use one feature tag, such as notes-search, for related work. See the creation reference for other document types.

Check records

Command

uvx vaultspec-core vault check all

Read the findings as well as the exit code. The untouched research template in this walkthrough produces five warnings and exit code 0; only errors fail the check. A successful check does not mean the research is finished or the code is correct.

Fill in the record, then check again. The verification guide explains checks, repairs, and automation.

Get JSON output

Command

uvx vaultspec-core status --json
uvx vaultspec-core vault list --feature notes-search --json

These return the same project state and record listing in machine-readable form. Every --json command emits one output envelope.

Where to go next

Run a feature explains what to review at each stage. For editing steps, recording completed work, renaming a feature, or archiving records, use the plan and feature commands.