Docs

FDEOps documentation

Installation, task instructions, customer records and the local CLI. Start with the guide for the job you need to do.

Install FDEOps Choose a skill Follow a tutorial

Find the right guide

Quick startProduct overview and first use.Installation and upgradesHost setup, full-pack installation and updates.Daily use and CLICustomer records and command walkthroughs.Task referenceInputs and results for every task skill.Record schemaFile structure and supported values.Host adaptersWorkspace pointers for supported agents.PrivacyLocal records, masking and model-provider boundaries.SecurityThreat model and reporting vulnerabilities.VerificationWhat has been tested and what remains unproven.ContributingDevelopment conventions and checks.

Command reference

All examples use npx so a copied command does not assume a global install.

npx fdeops scan

Read local repository files and print an initial assessment. Does not create a customer record or change the repository.

npx fdeops demo

Run fictional sample notes through the CLI review flow and generate a fieldbook. Creates or resets the demo folder.

npx fdeops resume --init client01

Create a customer record and link the current workspace to it.

npx fdeops resume

Read a short summary of the selected customer's record. The default output cap is 16 KiB.

npx fdeops recall "retry approval"

Find matching details in the selected customer's record with file references.

npx fdeops debrief --smart notes.md

Prepare a pending record-update proposal from a local notes file. The CLI uses fixed rules to process notes; ask your agent to check the interpretation.

npx fdeops debrief --review

Reopen the pending proposal to check the interpretation, sources and unresolved questions before applying it.

npx fdeops debrief --apply

Apply the pending proposal after you have reviewed it.

npx fdeops defend

Separate recorded assertions, sources and evidence gaps for review. A source reference does not authenticate the claim.

npx fdeops handoff --out successor.md

Generate a concise handoff summary. Review it before sharing; an exported file is not a completed operational handoff.

npx fdeops dashboard --all --open

Generate and open a read-only view of customer records. Regenerate after updates.

Agent skills interpret the task and guide the work. The CLI performs local file operations. Direct write commands apply changes when invoked; do not treat every CLI command as a draft or dry run.

Full CLI guide

Customer records

The customer record and the fieldbook

The customer record is Markdown stored by default at ~/fde-engagements/<client>/.fde/. The fieldbook is a read-only HTML view generated from those files.

The record keeps requests, decisions, evidence, risks and next actions together. The agent proposes judgment updates for review. Enabled session hooks can capture mechanical progress automatically.

Keep requests, agreements, verification and customer acceptance distinct. Record the evidence you have; leave missing information visible. People retain decision authority.

Explore the record files

context.md: Current state and next actions.
brief.md: The customer's request and constraints.
success.md: Outcome criteria and acceptance authority.
reality.md: Working theory, evidence and differences from the brief.
terrain.md: Relevant systems, teams and constraints.
stakeholders.md: Evidence-backed stakeholder observations and decision rights.
trust-profile.md: Access constraints, sensitive information and AI-use rules.
decisions.md: Dated decisions, reasons and sources.
risks.md: Open and retired risks.
delivery.md: Promises, measurements, acceptance and evidence.

See the record schema for exact headings and allowed values.

Install for your agent Follow a tutorial