AgentContextKit 0.2.0-alpha.3

<div align="center">

AgentContextKit

Offline-first repository context and safety tooling for AI-assisted development.

Analyze a repository, generate clean agent context files, create task-first workflow docs, and catch secret/PII/brand leakage risks before a project is shared with AI agents or released publicly.

<p> <a href="https://github.com/Cynrath/agent-context-kit/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/Cynrath/agent-context-kit/actions/workflows/ci.yml/badge.svg"></a> <a href="https://github.com/Cynrath/agent-context-kit/actions/workflows/cross-platform-smoke.yml"><img alt="Cross-platform smoke" src="https://github.com/Cynrath/agent-context-kit/actions/workflows/cross-platform-smoke.yml/badge.svg"></a> <a href="https://github.com/Cynrath/agent-context-kit/actions/workflows/cross-platform-source-smoke.yml"><img alt="Current-source smoke" src="https://github.com/Cynrath/agent-context-kit/actions/workflows/cross-platform-source-smoke.yml/badge.svg"></a> </p>

<p> <a href="https://www.nuget.org/packages/AgentContextKit"><img alt="NuGet" src="https://img.shields.io/nuget/v/AgentContextKit?label=NuGet&logo=nuget"></a> <a href="https://www.nuget.org/packages/AgentContextKit"><img alt="NuGet downloads" src="https://img.shields.io/nuget/dt/AgentContextKit?label=downloads&logo=nuget"></a> <a href="LICENSE"><img alt="License" src="https://img.shields.io/github/license/Cynrath/agent-context-kit"></a> <a href="https://dotnet.microsoft.com/"><img alt=".NET 10" src="https://img.shields.io/badge/.NET-10-512BD4?logo=dotnet&logoColor=white"></a> </p>

<p> <a href="#-quick-start"><strong>Quick Start</strong></a> · <a href="#-preview"><strong>Preview</strong></a> · <a href="#-what-it-does"><strong>Features</strong></a> · <a href="#-cli-command-map"><strong>CLI</strong></a> · <a href="#-safety-model"><strong>Safety</strong></a> · <a href="#-documentation-map"><strong>Docs</strong></a> </p>

</div>

Default commands process repository content locally: no repository upload, AI API call, telemetry, or external-tool invocation. See No-Network Default Policy.

---

Project Status

Area	Status
Current release	v0.2.0-alpha.2 published on GitHub and NuGet as a pre-release
Local candidate	Source/package metadata prepared as 0.2.0-alpha.3; hosted RC evidence and publication pending
Package	AgentContextKit global tool install verified
Previous release	v0.1.0-alpha.2
Runtime	.NET 10
Platforms	Windows, Ubuntu, macOS via GitHub Actions smoke flows
Privacy model	Offline-first; no repository upload and no remote AI API calls in the MVP
SARIF	ackit sarif is included in the published 0.2.0-alpha.2 package

---

Preview

The Web UI dashboard shows readiness score, stack signals, health checks, findings, generated context files, and task previews.

Screenshots are intentionally not committed yet until sanitized assets are available. See Web UI Preview, Visual Assets, Sample Gallery, and Demo Scenarios.

---

Related ecosystem

AgentContextKit prepares a repository before it reaches an AI coding agent or release decision. Specialized local tools can complement that workflow, but AgentContextKit does not install or invoke external tools by default.

• Repo-to-context packers can create model-ready bundles after local hygiene review.
• Graph and search tools can add optional architecture/navigation context.
• Security scanners and SBOM tools can provide deeper, separately reviewed evidence.
• External outputs remain local-only until a human privacy review approves sharing.

See Related Projects, Comparison Matrix, External Workflows, and Agent Context Pipeline.

---

Why AgentContextKit

AI coding agents are powerful, but they often receive incomplete, stale, or unsafe project context. That can lead to wrong edits, weak task planning, inconsistent agent instructions, missed test expectations, and accidental exposure when a private repository becomes public.

AgentContextKit gives teams a repeatable local workflow before they hand a repository to Codex, Claude Code, Cursor, GitHub Copilot, Gemini CLI, or similar coding agents.

Problem	AgentContextKit helps by
Agent context is scattered	Generating consistent agent instruction and workflow files
Repository structure is unclear	Producing a concise project map and stack signal summary
Work starts without task discipline	Creating structured task files under docs/tasks
Public release has leakage risk	Reporting secret-like, PII-like, brand, and local-path findings
CI needs machine-readable checks	Supporting JSON output and scan --ci severity gates
Review artifacts need to stay local	Creating offline HTML, Web UI, prompt pack, and context export artifacts

---

What It Does

Capability	Command	Output
Initialize config	ackit init	.ackit/config.yml
Validate config	ackit config-check	Read-only sanitized diagnostics and migration guidance
Scan repository	ackit scan	Stack, docs, tests, CI, Docker, agent files, risky paths
Filter scan scope	ackit scan --include <glob> --exclude <glob>	Current-source ad-hoc include/exclude filters
Fail CI on risk	ackit scan --ci	Non-zero exit on high or critical findings
Record reviewed findings	ackit baseline	Sanitized local baseline for opt-in new-finding CI policy
Generate SARIF	ackit sarif	Privacy-first SARIF 2.1.0 report from the published package or current source
Build HTML report	ackit report	Offline static scan report
Build Web UI prototype	ackit webui	Offline static review UI
Prepare prompt pack	ackit prompt-pack	Local dry-run prompt pack; no remote call
Export approved context manifest	ackit context-export	Local approval manifest
Generate agent files	ackit generate	Codex, Claude, Cursor, Copilot context files
Create task docs	ackit task	Structured task Markdown files
Check sensitive content	ackit redact-check	Secret/PII/brand/local-path risk report
Check repository health	ackit doctor	OSS and repo hygiene diagnostics
Run local MCP transport	ackit mcp --stdio-server	Current-source local JSON-RPC stdio loop
Compare baselines	ackit diff	Current-source sanitized baseline diff
Trim context artifacts	ackit trim	Current-source size-bounded Markdown/JSON trimming
Watch local changes	ackit watch	Current-source debounced local scan watcher

---

Quick Start

Install from NuGet

dotnet tool install --global AgentContextKit --version 0.2.0-alpha.2
ackit version
ackit --help

Run scans from the root of the repository you want to inspect:

ackit scan
ackit scan --ci
ackit doctor

scan --ci returns a non-zero exit code for High or Critical findings. Start with ackit scan when you want report-only behavior.

The published 0.2.0-alpha.2 package supports read-only config diagnostics and an explicit baseline workflow:

ackit config-check --json
ackit baseline
ackit scan --baseline .ackit-baseline.json --ci
ackit sarif --output .ackit/reports/baseline.sarif --baseline .ackit-baseline.json
ackit report --output .ackit/reports/baseline.html --baseline .ackit-baseline.json
ackit webui --output .ackit/webui/baseline.html --baseline .ackit-baseline.json

Baseline mode keeps existing findings visible but fails CI only for new High or Critical findings. Baseline replacement requires ackit baseline --update.

Common installed-tool workflows

Create local review artifacts:

ackit sarif --output .ackit/reports/ackit.sarif
ackit report --output .ackit/reports/scan-report.html
ackit webui --output .ackit/webui/index.html

Initialize and generate agent context:

ackit init --lang en
ackit generate --target all --lang en
ackit task "Add permission checks" --lang en

Generated .ackit/ reports and Web UI files are local-only artifacts and should be reviewed before sharing.

Run from source

Run these commands from the AgentContextKit repository root:

dotnet restore AgentContextKit.sln
dotnet build AgentContextKit.sln -c Release --no-restore
dotnet test AgentContextKit.sln -c Release --no-build
dotnet run --project src/AgentContextKit.Cli/AgentContextKit.Cli.csproj -c Release --no-build -- --help
dotnet run --project src/AgentContextKit.Cli/AgentContextKit.Cli.csproj -c Release --no-build -- scan --ci
dotnet run --project src/AgentContextKit.Cli/AgentContextKit.Cli.csproj -c Release --no-build -- scan --json
dotnet run --project src/AgentContextKit.Cli/AgentContextKit.Cli.csproj -c Release --no-build -- scan --include 'src/**' --exclude '**/*.bak' --ci
dotnet run --project src/AgentContextKit.Cli/AgentContextKit.Cli.csproj -c Release --no-build -- sarif --output .ackit/reports/ackit.sarif

The published 0.2.0-alpha.2 package adds sanitized suppression audit fields to human/JSON scan output.

Current source is prepared as the 0.2.0-alpha.3 local candidate and includes scan glob filters plus local-only mcp, diff, trim, and watch commands. These current-source command map entries do not imply that 0.2.0-alpha.3 is published on NuGet.

Try it on a sample

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

See Sample Gallery and Demo Scenarios for guided examples.

New to the tool? Follow First Five Minutes With Ackit for a disposable, copy-paste-ready walkthrough using the published package.

Adopting it in a real project? Use Prepare A Repository For AI Coding Agents for the security, config, generation, task-first, and CI-readiness workflow.

<details> <summary><strong>Installed-tool smoke test</strong></summary>

$smoke = Join-Path $env:TEMP "ackit-smoke-test"
New-Item -ItemType Directory -Force -Path $smoke | Out-Null
Push-Location $smoke
dotnet new console -n DemoApp
Push-Location DemoApp
git init
ackit init --lang tr
ackit scan --ci
ackit generate --target all --lang tr
ackit task "Demo smoke test task" --lang en
ackit report --output .ackit/reports/smoke.html
ackit webui --output .ackit/webui/index.html
ackit prompt-pack --output .ackit/prompt-packs/smoke.md --json
ackit context-export --prompt-pack .ackit/prompt-packs/smoke.md --approve --output .ackit/context-exports/smoke.json --json
Pop-Location
Pop-Location

ackit doctor can report missing README, LICENSE, SECURITY, tests, CI, .gitignore, or package metadata in a minimal demo app. That is expected repository-health output, not a tool failure.

</details>

---

CLI Command Map

This map follows current-source --help, docs/CLI_CONTRACT.md, and docs/CLI_REFERENCE.md. The published NuGet package remains 0.2.0-alpha.2; the 0.2.0-alpha.3 source candidate still needs hosted RC evidence and publication approval.

ackit init [--lang en|tr] [--json]
ackit config-check [--lang en|tr] [--json]
ackit scan [--baseline <repo-relative.json>] [--include <glob>] [--exclude <glob>] [--lang en|tr] [--json] [--ci]
ackit baseline [--output <repo-relative.json>] [--update] [--lang en|tr] [--json]
ackit sarif --output <repo-relative.sarif> [--baseline <repo-relative.json>] [--lang en|tr] [--json]
ackit report [--output <repo-relative.html>] [--baseline <repo-relative.json>] [--lang en|tr] [--json]
ackit webui [--output <repo-relative.html>] [--baseline <repo-relative.json>] [--lang en|tr] [--json]
ackit prompt-pack [--output <repo-relative.md>] [--lang en|tr] [--json]
ackit context-export --prompt-pack <repo-relative.md> --approve [--output <repo-relative.json>] [--lang en|tr] [--json]
ackit generate [--target codex|claude|anthropic|cursor|copilot|continue|all] [--lang en|tr] [--json]
ackit task "<title>" [--lang en|tr] [--json]
ackit redact-check [--profile public-release] [--lang en|tr] [--json]
ackit doctor [--lang en|tr] [--json]
ackit hooks [--target codex|claude|anthropic|continue] [--shell pwsh|sh] [--install|--dry-run] [--output <repo-relative-dir>] [--lang en|tr] [--json]
ackit mcp --stdio-server [--repo <path>] [--lang en|tr]
ackit mcp --stdio <json-request> [--output <repo-relative.jsonl>] [--lang en|tr]
ackit diff --from <from.json> --to <to.json> [--lang en|tr] [--json]
ackit trim --input <repo-relative.md|json> --output <repo-relative.md|json> --max-chars <N> [--lang en|tr] [--json]
ackit watch [--debounce-ms <N>] [--once] [--max-runtime-ms <N>] [--json] [--lang en|tr]
ackit version
ackit --help

Generated Files

Depending on the command and selected target, AgentContextKit can generate:

Area	Files
Agent instructions	AGENTS.md, CLAUDE.md, .cursor/rules/project.mdc, .github/copilot-instructions.md
Project workflow	docs/PROJECT_MAP.md, docs/AI_WORKFLOW.md, docs/SECURITY_NOTES.md, docs/DEVELOPMENT_STANDARD.md
Task tracking	docs/tasks/TASK-0001.md
Codex handoff	.codex/HANDOFF.md, .codex/CONTEXT_PACK.md
Reports	.ackit/reports/scan-report.html, .ackit/reports/ackit.sarif
Review UI	.ackit/webui/index.html
Prompt review	.ackit/prompt-packs/prompt-pack.md
Context approval	.ackit/context-exports/context-export-manifest.json

---

Safety Model

AgentContextKit is designed to make repository review safer before public release or AI-context export.

Behavior	Default
Remote AI/API calls	No remote AI calls in the MVP
Repository upload	No upload of repository contents
Existing generated files	Skipped by default
Secret redaction	No automatic redaction in the MVP
Risk severity	Critical, High, Medium, Low, Info
SARIF content	Repository-relative locations; raw secret matches are not written
Prompt packs	Local dry-run artifacts only
Context exports	Local approval manifest only
Publishing	No GitHub push or NuGet publish is performed by the tool

The scanner uses stable rule IDs and a narrow safe technical allowlist for common platform/package domains, known non-Critical paths, and clearly non-real fixture placeholders. Configured scanner allowlists can suppress non-Critical noise, but Critical findings remain reportable.

---

Localization

Default language is English. Turkish is supported with --lang tr. Unknown language values fall back to English.

ackit init --lang tr
ackit scan --lang tr
ackit generate --target all --lang tr
ackit task "Yetki kontrollerini ekle" --lang tr

---

Configuration And Automation

Topic	Documentation
.ackit/config.yml	Configuration
Machine-readable output	JSON Output
CI usage	GitHub Actions Usage
Scanner behavior	Scanner Rules
Suppression audit	Suppression Audit
Exit behavior	Exit Codes
SARIF report	SARIF Output

---

Documentation Map

Start with Documentation Index.

Category	Links
Usage	CLI Reference, Examples, Example Workflows
Demo	Sample Gallery, Demo Scenarios, Web UI Preview
Reports	HTML Reports, SARIF Output, Web UI Prototype, Visual Assets
Operations	Configuration, JSON Output, Suppression Audit, Troubleshooting
Engineering	Architecture, Source Hygiene, Security Model
Packaging	Packaging, Release Validation, Maintainer Release Handoff
Maintainers	Contributor Onboarding, Support Matrix, Maintainer Guide
GitHub setup	GitHub Labels, GitHub Settings Checklist, GitHub Repo Hygiene, Issue Triage
Release readiness	Public Release Audit, Release Blockers

---

Roadmap

See Roadmap.

Public release blockers are tracked in Release Blockers.

---

Packaging

Local package validation is documented in Packaging and Release Validation. The 0.2.0-alpha.2 package is published as a NuGet global tool; 0.2.0-alpha.3 is a local source/package candidate until a later authorized publish.

dotnet tool install --global AgentContextKit --version 0.2.0-alpha.2
ackit version

---

Contributing

See CONTRIBUTING.md and Contributor Onboarding. Please use the GitHub issue and pull request templates, and do not include secrets or private repository data in public reports.

---

Security

See SECURITY.md. Please do not include secrets, private repository contents, production configuration, or private customer data in public issues.

---

License

MIT. See LICENSE.