Skip to content

EXAMPLES.md

Latest commit

 

History

History
85 lines (66 loc) · 2.25 KB

EXAMPLES.md

File metadata and controls

85 lines (66 loc) · 2.25 KB

Examples

For a complete beginner flow from install to generated context, start with First Five Minutes With Ackit.

For an existing-repository adoption workflow, use Prepare A Repository For AI Coding Agents.

Start In A Repository

ackit init --lang en
ackit scan
ackit scan --ci
ackit doctor

Create AI Agent Files

ackit generate --target all --lang en

Existing files are skipped. Review every generated file before committing.

Create A Task

ackit task "Add role based authorization checks" --lang en

Public Release Review

ackit scan
ackit redact-check --profile public-release
ackit doctor

CI-Friendly JSON

ackit scan --json
ackit scan --ci --json
ackit redact-check --profile public-release --json
ackit doctor --json

HTML Report

ackit report --output .ackit/reports/current.html --json

Web UI Prototype

ackit webui --output .ackit/webui/current.html --json

Dry-Run Prompt Pack

ackit prompt-pack --output .ackit/prompt-packs/current.md --json

Review the generated Markdown locally before any future context export. The command does not call a remote provider.

User-Approved Context Export Manifest

ackit context-export --prompt-pack .ackit/prompt-packs/current.md --approve --output .ackit/context-exports/current.json --json

The manifest records local approval only. It does not upload the prompt pack or call a remote provider.

Local Package Validation

powershell -ExecutionPolicy Bypass -File scripts/verify-release.ps1

Scan Samples

Push-Location samples/dotnet-minimal-api
dotnet run --project ../../src/AgentContextKit.Cli/AgentContextKit.Cli.csproj -c Release --no-build -- scan
Pop-Location

Push-Location samples/node-tooling
dotnet run --project ../../src/AgentContextKit.Cli/AgentContextKit.Cli.csproj -c Release --no-build -- scan
Pop-Location

See SAMPLES.md.

Workflow Collections

See EXAMPLE_WORKFLOWS.md for copy-paste-ready local development, CI, HTML report, Web UI, prompt pack, public release preflight, and sample scanning workflows.