PyPI - arckit-cli - Versions diffs - 6.1.1__py3-none-any.whl - Mend

arckit-cli 6.1.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (482) hide show

arckit_cli-6.1.1.data/data/share/arckit/docs/README.md ADDED Viewed

@@ -0,0 +1,322 @@
+# ArcKit Documentation
+Complete documentation for ArcKit — The Enterprise Architecture Governance Harness.
+---
+## 📚 Quick Links
+- [Getting Started](../README.md#getting-started)
+- [Command Reference](../README.md#commands)
+- [Articles](articles.html)
+- [Token Limits Guide](TOKEN-LIMITS.md)
+---
+## Articles
+- [ArcKit TOGAF ADM: The Method Becomes a Governed Workflow](article-viewer.html?a=2026-07-01-arckit-togaf-adm)
+- [ArcKit AI Agent Architecture: Governed Design for Autonomous Systems](article-viewer.html?a=2026-06-30-arckit-agent-architecture)
+- [I Built ArcKit for Myself. Thank You for Using It.](article-viewer.html?a=2026-06-29-arckit-usage-signals)
+See the [full articles index](articles.html) for all ArcKit release notes, analysis, and essays.
+---
+## 📖 Guides
+### Getting Started
+- [Getting Started](guides/start.md) - `/arckit:start` - Onboarding walkthrough
+- [ArcKit Init](guides/init.md) - `/arckit:init` - Project initialization
+- [Template Customization](guides/customize.md) - `/arckit:customize` - Customize templates for your organization
+- [Template Builder](guides/template-builder.md) - `/arckit:template-builder` - Build custom document templates
+- [Upgrading ArcKit](guides/upgrading.md) - Version upgrade instructions
+- [Remote Control](guides/remote-control.md) - Remote architecture governance
+- [Productivity](guides/productivity.md) - Workflow optimization tips
+- [ArcKit at Enterprise Scale](guides/enterprise-scale.md) - Multi-repo, multi-application topology and governance
+### Discovery
+- [Requirements Definition](guides/requirements.md) - `/arckit:requirements`
+- [Stakeholder Analysis](guides/stakeholders.md) - `/arckit:stakeholders`
+- [Technology Research](guides/research.md) - `/arckit:research`
+- [Data Source Discovery](guides/datascout.md) - `/arckit:datascout`
+### Planning
+- [Project Plan](guides/plan.md) - `/arckit:plan`
+- [Business Case](guides/business-case.md) - `/arckit:sobc`
+- [Architecture Strategy](guides/strategy.md) - `/arckit:strategy`
+- [Architecture Roadmap](guides/roadmap.md) - `/arckit:roadmap`
+- [Product Backlog](guides/backlog.md) - `/arckit:backlog`
+- [File Migration](guides/migration.md) - Migrate files to new naming convention
+### Architecture
+- [Architecture Principles](guides/principles.md) - `/arckit:principles`
+- [Architecture Diagrams](guides/diagram.md) - `/arckit:diagram` - C4 Model visualization
+- [Data Model](guides/data-model.md) - `/arckit:data-model`
+- [ADR](guides/adr.md) - `/arckit:adr` - Architecture Decision Records
+- [Design Reviews](guides/design-review.md) - `/arckit:hld-review`, `/arckit:dld-review`
+- [Data Flow Diagrams](guides/dfd.md) - `/arckit:dfd`
+- [Framework Design](guides/framework.md) - `/arckit:framework`
+- [Platform Design](guides/platform-design.md) - `/arckit:platform-design`
+- [Wardley Mapping](guides/wardley.md) - `/arckit:wardley`
+- [Value Chain Decomposition](guides/wardley-value-chain.md) - `/arckit:wardley.value-chain`
+- [Doctrine Assessment](guides/wardley-doctrine.md) - `/arckit:wardley.doctrine`
+- [Gameplay Analysis](guides/wardley-gameplay.md) - `/arckit:wardley.gameplay`
+- [Climate Assessment](guides/wardley-climate.md) - `/arckit:wardley.climate`
+- [Data Mesh Contract](guides/data-mesh-contract.md) - `/arckit:data-mesh-contract`
+- [C4 Layout Science](guides/c4-layout-science.md) - Research-backed diagram layout
+### TOGAF ADM Overlay
+- [ADM Preliminary](guides/adm-preliminary.md) - `/arckit:adm-preliminary`
+- [Business Capability Map](guides/business-capability-map.md) - `/arckit:business-capability-map`
+- [Application Inventory](guides/application-inventory.md) - `/arckit:application-inventory`
+- [Application Rationalization](guides/application-rationalization.md) - `/arckit:application-rationalization`
+- [TOGAF Gap Analysis](guides/gap-analysis.md) - `/arckit:gap-analysis`
+- [Transition Architecture](guides/transition-architecture.md) - `/arckit:transition-architecture`
+- [Architecture Board](guides/architecture-board.md) - `/arckit:architecture-board`
+- [Architecture Change Request](guides/architecture-change.md) - `/arckit:architecture-change`
+- [Architecture Repository](guides/architecture-repository.md) - `/arckit:architecture-repository`
+### AI Agent Architecture Overlay
+- [AI Agent Inventory](guides/agent-inventory.md) - `/arckit:agent-inventory`
+- [AI Agent Design](guides/agent-design.md) - `/arckit:agent-design`
+- [AI Agent Governance](guides/agent-governance.md) - `/arckit:agent-governance`
+- [AI Agent Integration](guides/agent-integration.md) - `/arckit:agent-integration`
+- [AI Agent Security](guides/agent-security.md) - `/arckit:agent-security`
+- [AI Agent Maturity](guides/agent-maturity.md) - `/arckit:agent-maturity`
+### Governance
+- [Navigator](guides/navigator.md) - `/arckit:navigator` - Project-level GPS, recommended next command
+- [Graph Report](guides/graph-report.md) - `/arckit:graph-report` - Governance metrics dashboard across all projects
+- [Risk Management](guides/risk-management.md) - `/arckit:risk`
+- [Traceability](guides/traceability.md) - `/arckit:traceability`
+- [Principles Compliance](guides/principles-compliance.md) - `/arckit:principles-compliance`
+- [Project Analysis](guides/analyze.md) - `/arckit:analyze`
+- [Artifact Health](guides/artifact-health.md) - `/arckit:health`
+- [Architecture Search](guides/search.md) - `/arckit:search`
+- [Impact Assessment](guides/impact.md) - `/arckit:impact`
+- [Conformance](guides/conformance.md) - `/arckit:conformance`
+- [Knowledge Compounding](guides/knowledge-compounding.md) - Reusable vendor profiles
+- [Data Quality Framework](guides/data-quality-framework.md) - UK Government data quality
+- [Health Metrics](guides/health.md) - Project health scoring
+- [Maturity Model](guides/maturity-model.md) - Architecture maturity assessment
+### Compliance
+- [Technology Code of Practice](guides/uk-government/technology-code-of-practice.md) - `/arckit:tcop`
+- [Secure by Design](guides/uk-government/secure-by-design.md) - `/arckit:secure`
+- [DPIA](guides/dpia.md) - `/arckit:dpia` - Data Protection Impact Assessment
+- [Service Assessment](guides/service-assessment.md) - `/arckit:service-assessment`
+- [GovS 007 Security](guides/govs-007-security.md) - Security principles and role mapping
+- [National Data Strategy](guides/national-data-strategy.md) - NDS missions and pillars
+- [Codes of Practice](guides/codes-of-practice.md) - Rainbow of Books mapping
+- [Security Hooks](guides/security-hooks.md) - Three-layer secret protection
+- [AI Playbook](guides/uk-government/ai-playbook.md) - `/arckit:ai-playbook`
+- [Algorithmic Transparency](guides/uk-government/algorithmic-transparency.md) - `/arckit:atrs`
+- [MOD Secure by Design](guides/uk-mod/secure-by-design.md) - `/arckit:mod-secure`
+- [JSP 936 AI Assurance](guides/jsp-936.md) - `/arckit:jsp-936`
+### Operations
+- [DevOps Strategy](guides/devops.md) - `/arckit:devops` - CI/CD, IaC, containers
+- [MLOps Strategy](guides/mlops.md) - `/arckit:mlops` - ML lifecycle, model monitoring
+- [FinOps Strategy](guides/finops.md) - `/arckit:finops` - Cloud cost management
+- [Operational Readiness](guides/operationalize.md) - `/arckit:operationalize` - SRE runbooks
+### Procurement
+- [Statement of Work](guides/procurement.md) - `/arckit:sow`
+- [Vendor Evaluation](guides/evaluate.md) - `/arckit:evaluate`
+- [Vendor Scoring](guides/score.md) - `/arckit:score`
+- [Procurement Market Intelligence](guides/tenders.md) - `/arckit:tenders`
+- [Competitor Landscape Intelligence](guides/competitors.md) - `/arckit:competitors`
+- [Digital Marketplace](guides/uk-government/digital-marketplace.md) - `/arckit:gcloud-search`, `/arckit:gcloud-clarify`, `/arckit:dos`
+### UK G-Cloud Supplier Overlay
+- [G-Cloud Supplier Profile](guides/supplier-profile.md) - `/arckit:supplier-profile`
+- [G-Cloud Service Design](guides/service-design.md) - `/arckit:service-design`
+- [G-Cloud Lot 1 Service Definition](guides/sdd-lot1.md) - `/arckit:sdd-lot1`
+- [G-Cloud Lot 2 Service Definition](guides/sdd-lot2.md) - `/arckit:sdd-lot2`
+- [G-Cloud Lot 3 Service Definition](guides/sdd-lot3.md) - `/arckit:sdd-lot3`
+- [G-Cloud Supplier Declaration](guides/declaration.md) - `/arckit:declaration`
+- [G-Cloud Pricing](guides/pricing.md) - `/arckit:pricing`
+- [G-Cloud Security Assertions](guides/security.md) - `/arckit:security`
+- [G-Cloud Competitor Benchmark](guides/gcloud-competitors.md) - `/arckit:gcloud-competitors`
+- [G-Cloud Submission Review](guides/review.md) - `/arckit:review`
+- [G-Cloud Submission Pack](guides/submission-pack.md) - `/arckit:submission-pack`
+### FDE Site Generator
+- [FDE Site Generator](guides/create.md) - `/arckit-fde:create`
+### Integrations
+- [AWS Research](guides/aws-research.md) - `/arckit:aws-research` (Requires AWS Knowledge MCP)
+- [Azure Research](guides/azure-research.md) - `/arckit:azure-research` (Requires Microsoft Learn MCP)
+- [GCP Research](guides/gcp-research.md) - `/arckit:gcp-research` (Requires Google Developer Knowledge MCP)
+- [MCP Servers](guides/mcp-servers.md) - Plugin MCP server configuration
+- [MCP Catalogue](MCP-CATALOGUE.md) - Every MCP tool, server, and consumer command
+- [Pinecone MCP](guides/pinecone-mcp.md) - Wardley Mapping book corpus search
+- [Trello Export](guides/trello.md) - `/arckit:trello` - Export backlog to Trello
+- [ServiceNow](guides/servicenow.md) - ServiceNow service catalogue design
+### Reporting
+- [Project Story](guides/story.md) - `/arckit:story` - Project narrative
+- [Presentation](guides/presentation.md) - `/arckit:presentation` - MARP slide decks
+- [Glossary](guides/glossary.md) - `/arckit:glossary` - Terminology reference
+- [GitHub Pages](guides/pages.md) - `/arckit:pages` - Documentation site generator
+### DDaT Role Guides
+Which commands should **you** use? Guides for 18 [DDaT Capability Framework](https://ddat-capability-framework.service.gov.uk/) roles:
+- **Architecture**: [Enterprise Architect](guides/roles/enterprise-architect.md) | [Solution Architect](guides/roles/solution-architect.md) | [Data Architect](guides/roles/data-architect.md) | [Security Architect](guides/roles/security-architect.md) | [Business Architect](guides/roles/business-architect.md) | [Technical Architect](guides/roles/technical-architect.md) | [Network Architect](guides/roles/network-architect.md)
+- **Chief Digital and Data**: [CTO/CDIO](guides/roles/cto-cdio.md) | [CDO](guides/roles/cdo.md) | [CISO](guides/roles/ciso.md)
+- **Product and Delivery**: [Product Manager](guides/roles/product-manager.md) | [Delivery Manager](guides/roles/delivery-manager.md) | [Business Analyst](guides/roles/business-analyst.md) | [Service Owner](guides/roles/service-owner.md)
+- **Data**: [Data Governance Manager](guides/roles/data-governance-manager.md) | [Performance Analyst](guides/roles/performance-analyst.md)
+- **IT Operations**: [IT Service Manager](guides/roles/it-service-manager.md)
+- **Software Development**: [DevOps Engineer](guides/roles/devops-engineer.md)
+See the [full index](guides/roles/README.md) for details.
+---
+## 🎯 By Use Case
+### "I'm starting a new project"
+1. Start here: [Project Plan](guides/plan.md) - See the full timeline
+2. Then: [Architecture Principles](guides/principles.md)
+3. Then: [Stakeholder Analysis](guides/stakeholders.md)
+4. Then: [Risk Management](guides/risk-management.md)
+5. Then: [Requirements Definition](guides/requirements.md)
+### "I need to procure a vendor"
+1. Define needs: [Requirements Definition](guides/requirements.md)
+2. Create RFP: [Vendor Procurement](guides/procurement.md)
+3. UK Gov: [Digital Marketplace](guides/uk-government/digital-marketplace.md)
+### "I'm reviewing a design"
+- [Design Reviews Guide](guides/design-review.md)
+### "I need audit traceability"
+- [Traceability Guide](guides/traceability.md)
+---
+## 🇬🇧 UK Government Specific
+- [Digital Marketplace Procurement](guides/uk-government/digital-marketplace.md) - G-Cloud, DOS framework
+---
+## 🔧 Technical Reference
+- [Export OKF](guides/export-okf.md) - `/arckit:export-okf` - Export ArcKit artifacts as OKF-compatible Markdown
+- [Import OKF](guides/import-okf.md) - `/arckit:import-okf` - Import OKF bundles as reviewable research notes
+- [Token Limits Solutions](TOKEN-LIMITS.md) - Handling large projects with AI token limits
+- Document Control Standard - See [CLAUDE.md](../CLAUDE.md#document-control-standard) for the canonical specification
+### Contributing
+- [Custom Commands Authoring](guides/custom-commands.md) - Add a new `/arckit.*` command: converter fan-out, frontmatter reference, worked example, testing checklist
+---
+## 📊 Documentation Coverage
+| Command | Guide | Status |
+|---------|-------|--------|
+| `/arckit:init` | [upgrading.md](guides/upgrading.md) | ✅ Complete |
+| `/arckit:plan` | [plan.md](guides/plan.md) | ✅ Complete |
+| `/arckit:principles` | [principles.md](guides/principles.md) | ✅ Complete |
+| `/arckit:stakeholders` | [stakeholders.md](guides/stakeholders.md) | ✅ Complete |
+| `/arckit:risk` | [risk-management.md](guides/risk-management.md) | ✅ Complete |
+| `/arckit:sobc` | [business-case.md](guides/business-case.md) | ✅ Complete |
+| `/arckit:requirements` | [requirements.md](guides/requirements.md) | ✅ Complete |
+| `/arckit:platform-design` | [platform-design.md](guides/platform-design.md) | ✅ Complete |
+| `/arckit:data-model` | [data-model.md](guides/data-model.md) | ✅ Complete |
+| `/arckit:data-mesh-contract` | [data-mesh-contract.md](guides/data-mesh-contract.md) | ✅ Complete |
+| `/arckit:dpia` | [dpia.md](guides/dpia.md) | ✅ Complete |
+| `/arckit:research` | [research.md](guides/research.md) | ✅ Complete |
+| `/arckit:azure-research` | [azure-research.md](guides/azure-research.md) | ✅ Complete |
+| `/arckit:aws-research` | [aws-research.md](guides/aws-research.md) | ✅ Complete |
+| `/arckit:gcp-research` | [gcp-research.md](guides/gcp-research.md) | ✅ Complete |
+| `/arckit:datascout` | [datascout.md](guides/datascout.md) | ✅ Complete |
+| `/arckit:wardley` | [wardley.md](guides/wardley.md) | ✅ Complete |
+| `/arckit:wardley.value-chain` | [wardley-value-chain.md](guides/wardley-value-chain.md) | ✅ Complete |
+| `/arckit:wardley.doctrine` | [wardley-doctrine.md](guides/wardley-doctrine.md) | ✅ Complete |
+| `/arckit:wardley.gameplay` | [wardley-gameplay.md](guides/wardley-gameplay.md) | ✅ Complete |
+| `/arckit:wardley.climate` | [wardley-climate.md](guides/wardley-climate.md) | ✅ Complete |
+| `/arckit:roadmap` | [roadmap.md](guides/roadmap.md) | ✅ Complete |
+| `/arckit:strategy` | [strategy.md](guides/strategy.md) | ✅ Complete |
+| `/arckit:adr` | [adr.md](guides/adr.md) | ✅ Complete |
+| `/arckit:diagram` | [diagram.md](guides/diagram.md) | ✅ Complete |
+| `/arckit:gcloud-search` | [digital-marketplace.md](guides/uk-government/digital-marketplace.md) | ✅ Complete |
+| `/arckit:gcloud-clarify` | [digital-marketplace.md](guides/uk-government/digital-marketplace.md) | ✅ Complete |
+| `/arckit:dos` | [digital-marketplace.md](guides/uk-government/digital-marketplace.md) | ✅ Complete |
+| `/arckit:sow` | [procurement.md](guides/procurement.md) | ✅ Complete |
+| `/arckit:evaluate` | [procurement.md](guides/procurement.md) | ✅ Complete |
+| `/arckit:hld-review` | [design-review.md](guides/design-review.md) | ✅ Complete |
+| `/arckit:dld-review` | [design-review.md](guides/design-review.md) | ✅ Complete |
+| `/arckit:backlog` | [backlog.md](guides/backlog.md) | ✅ Complete |
+| `/arckit:servicenow` | [design-review.md](guides/design-review.md) | ✅ Complete |
+| `/arckit:traceability` | [traceability.md](guides/traceability.md) | ✅ Complete |
+| `/arckit:analyze` | [analyze.md](guides/analyze.md) | ✅ Complete |
+| `/arckit:principles-compliance` | [principles-compliance.md](guides/principles-compliance.md) | ✅ Complete |
+| `/arckit:conformance` | [conformance.md](guides/conformance.md) | ✅ Complete |
+| `/arckit:service-assessment` | [service-assessment.md](guides/service-assessment.md) | ✅ Complete |
+| `/arckit:tcop` | [technology-code-of-practice.md](guides/uk-government/technology-code-of-practice.md) | ✅ Complete |
+| `/arckit:ai-playbook` | [ai-playbook.md](guides/uk-government/ai-playbook.md) | ✅ Complete |
+| `/arckit:atrs` | [algorithmic-transparency.md](guides/uk-government/algorithmic-transparency.md) | ✅ Complete |
+| `/arckit:secure` | [secure-by-design.md](guides/uk-government/secure-by-design.md) | ✅ Complete |
+| `/arckit:mod-secure` | [secure-by-design.md](guides/uk-mod/secure-by-design.md) | ✅ Complete |
+| `/arckit:jsp-936` | [jsp-936.md](guides/jsp-936.md) | ✅ Complete |
+| `/arckit:story` | [story.md](guides/story.md) | ✅ Complete |
+| `/arckit:operationalize` | [operationalize.md](guides/operationalize.md) | ✅ Complete |
+| `/arckit:devops` | [devops.md](guides/devops.md) | ✅ Complete |
+| `/arckit:mlops` | [mlops.md](guides/mlops.md) | ✅ Complete |
+| `/arckit:finops` | [finops.md](guides/finops.md) | ✅ Complete |
+| `/arckit:pages` | [pages.md](guides/pages.md) | ✅ Complete |
+| `/arckit:trello` | [trello.md](guides/trello.md) | ✅ Complete |
+| `/arckit:customize` | [customize.md](guides/customize.md) | ✅ Complete |
+| `/arckit:presentation` | [presentation.md](guides/presentation.md) | ✅ Complete |
+| `/arckit:health` | [artifact-health.md](guides/artifact-health.md) | ✅ Complete |
+| `/arckit:impact` | [impact.md](guides/impact.md) | ✅ Complete |
+| `/arckit:navigator` | [navigator.md](guides/navigator.md) | ✅ Complete |
+| `/arckit:graph-report` | [graph-report.md](guides/graph-report.md) | ✅ Complete |
+| `/arckit:search` | [search.md](guides/search.md) | ✅ Complete |
+| `/arckit:start` | [start.md](guides/start.md) | ✅ Complete |
+| `/arckit:template-builder` | [template-builder.md](guides/template-builder.md) | ✅ Complete |
+| `/arckit:framework` | [framework.md](guides/framework.md) | ✅ Complete |
+| `/arckit:glossary` | [glossary.md](guides/glossary.md) | ✅ Complete |
+| `/arckit:maturity-model` | [maturity-model.md](guides/maturity-model.md) | ✅ Complete |
+| `/arckit:score` | [score.md](guides/score.md) | ✅ Complete |
+**Coverage**: All core commands have user guides.
+---
+## 🤝 Contributing
+Found a gap or want to improve documentation?
+- [GitHub Issues](https://github.com/tractorjuice/arc-kit/issues)
+- [Pull Requests Welcome](https://github.com/tractorjuice/arc-kit/pulls)
+---
+**Last updated**: 2026-02-25
+**ArcKit Version**: 6.1.1