Quick Start

This page gets you to a first useful result: a read-only onboarding preview of your repository. It takes a few minutes and writes no files. Background and alternatives are on Installation and Getting Started.

Development preview

There is no published Kiyo release. The catalog commands below come from the framework README and point at the development packages committed in the repository. That catalog route has no recorded host test yet (NOT_TESTED). Use a disposable or non-critical project for your first trial.

The GitHub repository is now 0xPratyaDev7x/kiyo-axiom-framework. The framework README at the documented revision still shows the previous path 0xPratyaDev7x/kiyo-codejadee-framework, which GitHub redirects. Commands on this site use the current path.

Prerequisites

• One supported host, already installed and signed in with your own account: Claude Code (CLI or VS Code), Codex CLI, or GitHub Copilot (CLI or VS Code).
• A Git repository to try it on. Kiyo does not need Node.js, Python, or any other runtime on your machine.
• Nothing else. There is no Kiyo CLI, package manager step, or build step for users.

The Codex IDE extension is not supported. Its native plugins are documented as unsupported, so use Codex CLI instead.

Steps

1. Install the package. Run the two commands for your host. In Claude Code, type them in an interactive session; for Codex and Copilot, run them in PowerShell or your usual terminal.

   Claude Code

   Claude Code session

   /plugin marketplace add 0xPratyaDev7x/kiyo-axiom-framework
   /plugin install kiyo-axiom-framework@kiyo-codejadee

   Codex CLI

   PowerShell

   codex plugin marketplace add 0xPratyaDev7x/kiyo-axiom-framework
   codex plugin add kiyo-axiom-framework@kiyo-codejadee

   Start a new Codex session after installing. The OpenAI documentation says new plugins are picked up by new sessions.

   Copilot CLI

   PowerShell

   copilot plugin marketplace add 0xPratyaDev7x/kiyo-axiom-framework
   copilot plugin install kiyo-axiom-framework@kiyo-codejadee

2. Confirm the eight Skills are visible. Open your host’s Skill or plugin list and check that the Kiyo source shows init, requirement, implement, review, test, security, architecture, and memory.

3. Select Init explicitly. Explicit selection is the documented route. Do not rely on the host picking Kiyo automatically.

   Host	How to select Init
   Claude Code (CLI and VS Code)	/kiyo-axiom-framework:init
   Codex CLI	Open /skills or the $ picker and choose the Kiyo init entry
   Copilot CLI	Use /skills list and /skills info to find the Kiyo entry, then use the selector the host shows
   Copilot VS Code	/kiyo-axiom-framework:init, or choose the Kiyo entry in Configure Skills

   Do not use a host’s built-in /init or /review. They are different commands.

4. Ask for a preview. Paste this request after selecting Init:

   Preview onboarding for this repository; report evidence, unknowns and proposed Memory/config/bootstrap changes without writing files.

5. Read the report. Init samples a bounded set of files: up to 16 files and 1,200 lines across instructions, manifests and docs, and representative source and tests. The report lists what it inspected, what it could not establish (Unknowns), and the project-local changes it proposes.

Expected result

• Zero files changed. Preview mode is read-only by contract. Run git status afterwards to confirm the working tree is unchanged.
• A chat report that separates evidence-backed observations, unknowns, and proposals. For a new project, the proposals typically include .kiyo/policy.md and .kiyo/memory/index.md, plus an optional small managed block for your host’s project instructions.
• An honest activation note. Selecting the Skill shows it was discovered. It does not show that the Core loads automatically in every session.

If the Skill does not appear or resources are missing, see Troubleshooting.

Next steps

1. Initialize, if you want the proposed state. Ask Init to create only the project-local Memory and configuration it proposed. See Onboard a repository.
2. Pick a daily Skill: Requirement, Implement, Review, Test, Security, Architecture, or Memory. The Skill catalog lists what each one may and may not do.
3. Learn how to read reports. Checks, completion, reports explains PASS versus NOT_RUN, task statuses, and Memory impact.