First Workflows
Purpose
Run practical ae commands after a successful install so you can inspect, generate, registry-pull, verify, hub, and know with predictable outcomes.
Prerequisites
- Install completed and
ae definitionsucceeds.
Steps
After install + verify, run one of these workflows.
1) Inspect definition
bash
ae definitionWhen to use:
- Confirm CLI is reachable and working.
2) Preflight checks
bash
ae doctorWhen to use:
- Validate environment and trust setup before generation or registry operations.
3) Generate AE files
bash
ae generate --library-id dart_provider --library-root . --engine templateSafe preview:
bash
ae generate --library-id dart_provider --library-root . --engine template --check --diff4) Pull from registry
bash
ae registry get --library-id python_requests --action install --out ./ae_use5) Validate payloads
bash
ae verify --input verify.json
ae evaluate --input evaluate.json6) Initialize a hub
bash
ae hub initWhen to use:
- First time setup for local-first artifact storage.
- Before running
ae knoworae hub pullcommands.
7) Extract domain knowledge
bash
ae know build --url https://modelcontextprotocol.io/llms-full.txt --name mcpWhen to use:
- Before generating AE files for a new domain.
- To capture spec knowledge for the team.
8) Generate with domain context
bash
ae generate --library-id dart_mcp_sdk --library-root . --know mcpWhen to use:
- When you have domain knowledge stored and want AI-aware generation.
9) Compare knowledge versions
bash
ae know diff --from mcp_v1 --to mcp_v2When to use:
- Migration planning between spec versions.
- Understanding what changed in a domain.
10) Sync with remote
bash
ae hub pull --library-id python_requests
ae hub pushWhen to use:
- Share artifacts with team or pull shared projects locally.
Verify
Commands return expected outputs for your environment (see each step above for intent).
If it fails
On failure:
- Capture error code.
- Map code to recovery command.
- Re-run with corrected input.
Use the contract in docs/error_code_playbook.md and Troubleshooting.