Documentation Index Fetch the complete documentation index at: https://mintlify.com/tractorjuice/arc-kit/llms.txt
Use this file to discover all available pages before exploring further.
Command Reference Overview
ArcKit provides 54 commands for enterprise architecture governance, organized into workflow-driven categories. Each command generates structured documentation aligned with UK Government standards (GDS, TCoP, NCSC).
Command Types
ArcKit supports two command invocation patterns:
CLI Commands Direct shell commands using arckit binary
arckit init - Initialize project structure
arckit check - Verify installation
Slash Commands AI assistant integration via /arckit.* prefix
/arckit.plan - Generate project plans
/arckit.requirements - Create requirements
52 additional workflow commands
Maturity Status Legend
Status Description 🟢 Live Production-ready, extensively tested 🔵 Beta Feature-complete, actively refined 🟠 Alpha Working, limited testing 🟣 Experimental New in v0.11.x, early adopters
Example Test Repositories
All commands link to 20 public test repositories demonstrating real-world usage:
Command Categories
Foundation
Command Description Status /arckit.initInitialize ArcKit project structure with numbered project directories and global artifacts 🟢 Live /arckit.startGet oriented with ArcKit — check project status, explore available commands, and choose your next step 🟢 Live /arckit.planCreate project plan with timeline, phases, gates, and Mermaid diagrams 🟢 Live /arckit.principlesCreate or update enterprise architecture principles 🟢 Live
Strategic Context
Command Description Status /arckit.stakeholdersAnalyze stakeholder drivers, goals, and measurable outcomes 🟢 Live /arckit.riskCreate comprehensive risk register following HM Treasury Orange Book principles 🟢 Live /arckit.sobcCreate Strategic Outline Business Case (SOBC) using UK Government Green Book 5-case model 🟢 Live
Requirements & Data
Command Description Status /arckit.requirementsCreate comprehensive business and technical requirements 🟢 Live /arckit.data-modelCreate comprehensive data model with entity relationships, GDPR compliance, and data governance 🟢 Live /arckit.data-mesh-contractCreate federated data product contracts for mesh architectures with SLAs, governance, and interoperability guarantees 🟠 Alpha /arckit.dpiaGenerate Data Protection Impact Assessment (DPIA) for UK GDPR Article 35 compliance 🔵 Beta
Research & Strategy
Command Description Status /arckit.platform-designCreate platform strategy using Platform Design Toolkit (8 canvases for multi-sided ecosystems) 🟣 Experimental /arckit.researchResearch technology, services, and products to meet requirements with build vs buy analysis 🔵 Beta /arckit.wardleyCreate strategic Wardley Maps for architecture decisions and build vs buy analysis 🟣 Experimental /arckit.strategySynthesise strategic artifacts into executive-level Architecture Strategy document 🔵 Beta /arckit.roadmapCreate strategic architecture roadmap with multi-year timeline, capability evolution, and governance 🔵 Beta /arckit.adrDocument architectural decisions with options analysis and traceability 🔵 Beta
Cloud Research (MCP)
Command Description Status /arckit.azure-researchResearch Azure services and architecture patterns using Microsoft Learn MCP 🟣 Experimental /arckit.aws-researchResearch AWS services and architecture patterns using AWS Knowledge MCP 🟣 Experimental /arckit.gcp-researchResearch Google Cloud services and architecture patterns using Google Developer Knowledge MCP 🟣 Experimental
Data Source Discovery
Command Description Status /arckit.datascoutDiscover external data sources (APIs, datasets, open data portals) to fulfil project requirements 🟣 Experimental
Procurement
Command Description Status /arckit.sowGenerate Statement of Work (SOW) / RFP document for vendor procurement 🟢 Live /arckit.dosGenerate Digital Outcomes and Specialists (DOS) procurement documentation for UK Digital Marketplace 🟣 Experimental /arckit.gcloud-searchFind G-Cloud services on UK Digital Marketplace with live search and comparison 🟣 Experimental /arckit.gcloud-clarifyAnalyze G-Cloud service gaps and generate supplier clarification questions 🟣 Experimental /arckit.evaluateCreate vendor evaluation framework and score vendor proposals 🟢 Live
Design & Architecture
Command Description Status /arckit.diagramGenerate architecture diagrams using Mermaid for visual documentation 🟢 Live /arckit.hld-reviewReview High-Level Design (HLD) against architecture principles and requirements 🔵 Beta /arckit.dld-reviewReview Detailed Design (DLD) for implementation readiness 🔵 Beta
Operations
Command Description Status /arckit.backlogGenerate prioritised product backlog from ArcKit artifacts - convert requirements to user stories, organise into sprints 🔵 Beta /arckit.trelloExport product backlog to Trello - create board, lists, cards with labels and checklists from backlog JSON 🟣 Experimental /arckit.servicenowCreate comprehensive ServiceNow service design with CMDB, SLAs, incident management, and change control 🔵 Beta /arckit.devopsCreate DevOps strategy with CI/CD pipelines, IaC, container orchestration, and developer experience 🟣 Experimental /arckit.mlopsCreate MLOps strategy with model lifecycle, training pipelines, serving, monitoring, and governance 🟣 Experimental /arckit.finopsCreate FinOps strategy with cloud cost management, optimization, governance, and forecasting 🟣 Experimental /arckit.operationalizeCreate operational readiness pack with support model, runbooks, DR/BCP, on-call, and handover documentation 🟣 Experimental /arckit.traceabilityGenerate requirements traceability matrix from requirements to design to tests 🟢 Live
Quality & Governance
Command Description Status /arckit.analyzePerform comprehensive governance quality analysis across architecture artifacts 🔵 Beta /arckit.principles-complianceAssess compliance with architecture principles and generate scorecard with evidence, gaps, and recommendations 🟢 Live /arckit.storyGenerate comprehensive project story with timeline analysis, traceability, and governance achievements 🟢 Live /arckit.presentationGenerate MARP slide deck from project artifacts for governance boards and stakeholder briefings 🔵 Beta /arckit.conformanceAssess architecture conformance — ADR decision implementation, cross-decision consistency, architecture drift, technical debt, and custom constraint rules 🔵 Beta /arckit.healthScan projects for stale research, forgotten ADRs, unresolved review conditions, orphaned requirements, missing traceability, and version drift 🔵 Beta /arckit.customizeCopy templates to .arckit/templates-custom/ for customization (preserved across updates) 🟢 Live /arckit.template-builderCreate new document templates through interactive interview — generates community-origin templates, guides, and optional shareable bundles 🟠 Alpha
UK Government
Command Description Status /arckit.service-assessmentPrepare for GDS Service Standard assessment - analyze evidence against 14 points, identify gaps, generate readiness report 🔵 Beta /arckit.tcopGenerate a Technology Code of Practice (TCoP) review document for a UK Government technology project 🔵 Beta /arckit.secureGenerate a Secure by Design assessment for UK Government projects (civilian departments) 🔵 Beta /arckit.ai-playbookAssess UK Government AI Playbook compliance for responsible AI deployment 🟠 Alpha /arckit.atrsGenerate Algorithmic Transparency Recording Standard (ATRS) record for AI/algorithmic tools 🟠 Alpha
UK MOD
Command Description Status /arckit.mod-secureGenerate a MOD Secure by Design assessment for UK Ministry of Defence projects using CAAT and continuous assurance 🟣 Experimental /arckit.jsp-936Generate MOD JSP 936 AI assurance documentation for defence AI/ML systems 🟣 Experimental
Documentation & Publishing
Command Description Status /arckit.pagesGenerate documentation site with Mermaid diagram support 🟠 Alpha
Getting Started
Install ArcKit CLI
uv tool install arckit-cli
Initialize Project
arckit init my-architecture-project --ai codex
cd my-architecture-project
Start Using Commands
Launch your AI assistant and run: /arckit.start
/arckit.principles
/arckit.requirements
Next Steps
Initialize Project Set up your ArcKit project structure
Get Started Navigate ArcKit with guided onboarding
Create a Plan Generate project timeline with gates
Define Principles Establish architecture governance