Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/validate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ jobs:
- uses: actions/checkout@v4
- name: Install validation dependencies
run: python3 -m pip install -r requirements-dev.txt
- name: Install CLI package
run: python3 -m pip install -e .
- name: Check installed CLI
run: aicp --version && aicp --help
- name: Validate JSON and local Markdown links
run: python3 scripts/validate.py
- name: Validate contracts
Expand Down
5 changes: 5 additions & 0 deletions docs/GETTING_STARTED.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Getting started

## Optional CLI installation

From a playbook checkout with Python 3.10+, run `python3 -m pip install -e .` (preferably inside a virtual environment). This installs the `aicp` command so you can run `aicp --help`, `aicp init`, and `aicp verify` from other working directories. Installation does not install or authenticate any vendor coding assistant. The checkout-based `python3 -m aicp` commands below remain supported. This project is not yet published to a package index.


For a complete worked example, see the [practical walkthrough](PRACTICAL_WALKTHROUGH.md). For additional fictional scenarios and privacy guidance, see the [usage guide](USAGE_GUIDE.md).

## Quick setup
Expand Down
24 changes: 24 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[build-system]
requires = ["setuptools>=68"]
build-backend = "setuptools.build_meta"

[project]
name = "ai-coding-playbook"
version = "0.1.0"
description = "Engineering-first task, onboarding, and verification CLI for AI-assisted coding"
readme = "README.md"
requires-python = ">=3.10"
license = "Apache-2.0"
authors = [{name = "AI Coding Playbook contributors"}]
keywords = ["coding-assistants", "developer-tools", "verification"]
classifiers = [
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3 :: Only",
]
dependencies = []

[project.scripts]
aicp = "aicp.__main__:main"

[tool.setuptools]
packages = ["aicp"]
Loading