Generated onboarding

Quickstart

Install the Kit, start a new governed repository, or add the operating layer to an existing repository without moving project-owned source or release authority into the Kit.

Version 1.0.1 · Python >=3.10 · Package agentic-project-kit

Repository sources flow into generated public onboarding and command projections. — Commands and links are projected from the current manifest and repository docs.

Current public source

Install in a Virtual Environment

python -m venv .venv
source .venv/bin/activate
python -m pip install "agentic-project-kit @ git+https://github.com/vfi64/agentic-project-kit.git@main"
agentic-kit --version

This path matches the generated documentation on main. Direct PyPI installation is planned, not claimed yet.

Planned PyPI

Use After Publication

python -m venv .venv
source .venv/bin/activate
python -m pip install agentic-project-kit
agentic-kit --version

Use this only after the PyPI claim is verified on the claim-evidence page. TestPyPI smoke evidence is separate and does not prove pypi.org availability.

Kit checkout

Develop the Kit Locally

python -m venv .venv
source .venv/bin/activate
python -m pip install -e ".[dev]"
pytest -q
agentic-kit --version

Docker

Use the Local Image

git clone https://github.com/vfi64/agentic-project-kit.git
cd agentic-project-kit
docker build -t agentic-project-kit:local .
docker run --rm -v "/path/to/repo:/work" agentic-project-kit:local doctor --root /work

docker run --rm \
  -e GIT_AUTHOR_NAME="Your Name" \
  -e GIT_AUTHOR_EMAIL="you@example.com" \
  -e GIT_COMMITTER_NAME="Your Name" \
  -e GIT_COMMITTER_EMAIL="you@example.com" \
  -v "$PWD:/work" \
  agentic-project-kit:local init my-new-project --type generic --kit-source none

No official registry image is claimed by this generated site. Creating the initial convenience commit inside Docker requires a Git identity; otherwise the files are created and the commit is skipped with an explicit warning. GitHub operations inside Docker require mounted credentials for gh and SSH.

Updates

Update a Managed Repository

After updating the Kit package, inspect the target workspace before applying schema migrations. workspace upgrade is dry-run by default.

python -m pip install --upgrade "agentic-project-kit @ git+https://github.com/vfi64/agentic-project-kit.git@main"
agentic-kit doctor --root PATH
agentic-kit workspace upgrade --root PATH
agentic-kit workspace upgrade --root PATH --execute
agentic-kit check --root PATH
agentic-kit doctor --root PATH

Safety rule

Review the manifest diff before using --execute. If the manifest schema is older than this Kit supports, doctor reports the upgrade command explicitly.

New repository

Create a Governed Project

Use the scaffold path when the Kit should create the repository skeleton, project contract, docs, task gate files, CI template, and local quality gates.

agentic-kit init my-new-project \
  --type python-cli \
  --description "My new project" \
  --license MIT \
  --github-actions \
  --agent-docs
cd my-new-project
python -m venv .venv
source .venv/bin/activate
python -m pip install -e ".[dev]"
pytest -q
agentic-kit check
agentic-kit doctor

Projected commands

agentic-kit initCreate a governed project skeleton with selected profiles and policy packs.orchestrator · BOUNDED
agentic-kit checkRun agentic-kit check.diagnostic · READ_ONLY
agentic-kit doctorRun a compact project health check.diagnostic · READ_ONLY

Existing repository

Adopt Before Initializing

Use the brownfield path when project-owned files already exist. The first commands inspect and assess; the bounded write step is explicit.

agentic-kit workspace dpa-intake --root PATH
agentic-kit workspace adopt --root PATH
agentic-kit workspace init --root PATH
agentic-kit workspace init --root PATH --execute
agentic-kit check-docs --root PATH
agentic-kit check --root PATH
agentic-kit doctor --root PATH
cd PATH
agentic-kit transfer chat-switch-complete --render-prompt

Rollback remains dry-run first: agentic-kit workspace remove --root PATH, then agentic-kit workspace remove --root PATH --execute after review.