### Run JSONL Quickstart Example

Source: https://github.com/rohitg00/akbp/blob/main/examples/jsonl-quickstart/README.md

Execute the main quickstart script from the repository root.

```bash
./examples/jsonl-quickstart/run.sh
```

--------------------------------

### AKBP Installation Target Examples

Source: https://github.com/rohitg00/akbp/blob/main/docs/PROTOCOL_STANDARD_GAP_ANALYSIS.md

Provides examples of installation targets for AKBP, such as Python package metadata or install scripts, with commands like 'uvx akbp' or 'pipx install akbp'.

```text
Python package metadata or install script
```

```text
`uvx akbp` or `pipx install akbp` target
```

--------------------------------

### Run AKBP Adoption Preflight Example

Source: https://github.com/rohitg00/akbp/blob/main/examples/adoption-preflight/README.md

Execute the preflight script from the repository root to verify AKBP setup.

```bash
./examples/adoption-preflight/run.sh
```

--------------------------------

### Run AKBP Structured Output Harness Example

Source: https://github.com/rohitg00/akbp/blob/main/examples/structured-output-harness/README.md

Execute the AKBP structured output harness example from the repository root. This command initiates the primary example script.

```bash
./examples/structured-output-harness/run.sh
```

--------------------------------

### Run Source Intake Example

Source: https://github.com/rohitg00/akbp/blob/main/examples/source-intake/README.md

Execute the main source intake example from the repository root.

```bash
./examples/source-intake/run.sh
```

--------------------------------

### Run Portable Bundle Example

Source: https://github.com/rohitg00/akbp/blob/main/examples/portable-bundle/README.md

Execute the portable bundle example script from the repository root.

```bash
examples/portable-bundle/run.sh
```

--------------------------------

### Expected Success Markers

Source: https://github.com/rohitg00/akbp/blob/main/examples/jsonl-quickstart/README.md

Verify the output against these expected success markers to confirm the quickstart example passed.

```text
AKBP JSONL quickstart example
capability discovery ok
session start cited context ok
dry-run write preview ok
unapproved write blocked ok
approved write apply ok
index refresh ok
cited recall ok
portable export ok
portable export-check ok
AKBP JSONL quickstart example passed
```

--------------------------------

### Run Context Freshness Probe Example

Source: https://github.com/rohitg00/akbp/blob/main/examples/context-freshness-probe/README.md

Execute the context freshness probe example from the repository root.

```bash
./examples/context-freshness-probe/run.sh

```

--------------------------------

### Run AKBP Demo

Source: https://github.com/rohitg00/akbp/blob/main/README.md

Executes the demo script for first-time and new users to get started with AKBP.

```shell
make demo
```

--------------------------------

### Run Project Understanding Bridge Example

Source: https://github.com/rohitg00/akbp/blob/main/examples/project-understanding-bridge/README.md

Execute the example script from the repository root to process markdown files as source evidence.

```bash
./examples/project-understanding-bridge/run.sh

```

--------------------------------

### Run Adapter Lifecycle Example

Source: https://github.com/rohitg00/akbp/blob/main/docs/ADAPTER_AUTHOR_QUICKSTART.md

Execute the adapter lifecycle example script if the runtime includes a shutdown hook. This script should be run after other examples to test the full lifecycle management.

```bash
examples/adapter-lifecycle/run.sh
```

--------------------------------

### AKBP Context Start Request

Source: https://github.com/rohitg00/akbp/blob/main/adapters/example-coding-agent/session-start.md

Example JSON request to start a session and get context for the current task. It specifies the method, path, and parameters including the task description and a limit for context retrieval.

```json
{"id":"context-start","method":"akbp.context","path":".","params":{"task":"current task","limit":8}}
```

--------------------------------

### akbp.session.start Example

Source: https://github.com/rohitg00/akbp/blob/main/docs/TOOL_CONTRACT.md

Example of a call to akbp.session.start, which serves as the adapter-level session entrypoint. It returns a session ID and a cited context pack for the current task.

```json
{
  "id": "session-start-1",
  "method": "akbp.session.start",
  "path": ".",
  "params": {"task": "continue the release", "limit": 5, "max_chars": 4000}
}
```

--------------------------------

### Run Read-only Adapter Example

Source: https://github.com/rohitg00/akbp/blob/main/examples/read-only-adapter/README.md

Execute the shell script to run the read-only adapter example from the repository root.

```bash
examples/read-only-adapter/run.sh
```

--------------------------------

### Run Stdio Client Config Example

Source: https://github.com/rohitg00/akbp/blob/main/examples/stdio-client-config/README.md

Execute the provided shell script to run the stdio client configuration example from the repository root.

```bash
examples/stdio-client-config/run.sh
```

--------------------------------

### AKBP CLI: Initialize Knowledge Base (Installed Script)

Source: https://github.com/rohitg00/akbp/blob/main/README.md

Initialize a new AKBP knowledge base using the installed console script.

```bash
akbp --path ./my-kb init --level 0
```

--------------------------------

### Use Installed AKBP Command

Source: https://github.com/rohitg00/akbp/blob/main/docs/INSTALL.md

After local installation, use the 'akbp' command to interact with the tool.

```bash
akbp --help
akbp --path ./my-kb init
```

--------------------------------

### Project Understanding Bridge Example

Source: https://github.com/rohitg00/akbp/blob/main/docs/PROTOCOL_LANDSCAPE_LEARNINGS.md

This example demonstrates the comparison between plain markdown and AKBP for project understanding. It registers markdown as evidence, dry-runs durable promotion, and applies only reviewed claims.

```bash
examples/project-understanding-bridge/run.sh
```

--------------------------------

### Run JSONL Quickstart Script

Source: https://github.com/rohitg00/akbp/blob/main/README.md

Executes the JSONL quickstart script for JSONL tool authors.

```shell
examples/jsonl-quickstart/run.sh
```

--------------------------------

### Run Markdown Folder Intake Example

Source: https://github.com/rohitg00/akbp/blob/main/examples/markdown-folder-intake/README.md

Execute the example script from the repository root to initiate the markdown folder intake process. This script demonstrates creating a markdown note folder, registering files as source evidence, previewing claims, and applying reviewed knowledge.

```bash
./examples/markdown-folder-intake/run.sh
```

--------------------------------

### Generate Host Install Profiles with AKBP

Source: https://github.com/rohitg00/akbp/blob/main/docs/PROTOCOL_LANDSCAPE_LEARNINGS.md

Use `akbp client-config` to generate `host_install_profiles` for various agent types and runtimes. This ensures safe defaults, concrete setup steps, and controlled write access.

```bash
akbp client-config host_install_profiles
```

--------------------------------

### Install AKBP and Run Tool Server

Source: https://github.com/rohitg00/akbp/blob/main/README.md

Install the AKBP package locally using pip and run the tool server with input from a JSONL file.

```bash
python3 -m pip install .
akbp-tool-server < requests.jsonl
```

--------------------------------

### Install Build Frontend

Source: https://github.com/rohitg00/akbp/blob/main/docs/INSTALL.md

Install the 'build' package if it's not already present in your Python environment.

```bash
python3 -m pip install build
```

--------------------------------

### Run Inherited Repo Intake Example

Source: https://github.com/rohitg00/akbp/blob/main/examples/inherited-repo-intake/README.md

Execute the example script from the repository root to simulate a repo takeover. This script demonstrates the process of recording evidence, storing claims, building the index, and verifying the safe startup path.

```bash
./examples/inherited-repo-intake/run.sh
```

--------------------------------

### Run End-to-End Agent Flow Example

Source: https://github.com/rohitg00/akbp/blob/main/docs/RELEASE.md

Execute the end-to-end agent flow example with specified conformance level and query.

```bash
python3 cli/akbp.py --path examples/end-to-end-agent-flow conformance --level 3
python3 cli/akbp.py --path examples/end-to-end-agent-flow query "database migrations rollback"
python3 cli/akbp.py --path examples/end-to-end-agent-flow context "prepare migration release"
```

--------------------------------

### Install AKBP CLI Locally

Source: https://github.com/rohitg00/akbp/blob/main/cli/README.md

Install the AKBP CLI locally using pip for system-wide access. After installation, you can run commands directly using the 'akbp' alias.

```bash
python3 -m pip install .
akbp --help
```

--------------------------------

### Fastest Read-Only AKBP Setup

Source: https://github.com/rohitg00/akbp/blob/main/README.md

Commands to initialize a knowledge base and configure a read-only adapter for AKBP.

```bash
python3 cli/akbp.py --path ./my-kb init --level 0
python3 cli/akbp.py --path ./my-kb client-config --name my-adapter --profile read-only
```

--------------------------------

### Example Runtime-Neutral Adapter

Source: https://github.com/rohitg00/akbp/blob/main/docs/ADAPTERS.md

A complete example of a runtime-neutral adapter. Use this to understand the minimum complete file shape and structure.

```text
adapters/example-coding-agent/
```

--------------------------------

### Run Tool Error Handling Example Script

Source: https://github.com/rohitg00/akbp/blob/main/examples/tool-error-handling/README.md

Execute the main script for the tool error handling example from the repository root.

```bash
./examples/tool-error-handling/run.sh
```

--------------------------------

### Inspect Demo Output

Source: https://github.com/rohitg00/akbp/blob/main/docs/GETTING_STARTED.md

Examine the expected success markers from the AKBP quickstart demo to verify its correct execution.

```text
AKBP quickstart demo
"id": "caps", "ok": true
"id": "ingest-preview"
"code": "approval_required"
"id": "ingest-approved"
"id": "index-approved"
"verified": 1
"results": [
"items": [
"supersedes": [
"event": "supersede"
"ok": true
AKBP quickstart demo passed
```

--------------------------------

### Editor Coding Agent Setup

Source: https://github.com/rohitg00/akbp/blob/main/docs/ADAPTERS.md

Setup instructions for an editor coding agent. This path uses JSONL tool server with editor rules.

```text
adapters/editor-coding-agent/
```

--------------------------------

### Install AKBP Locally with Pip

Source: https://github.com/rohitg00/akbp/blob/main/docs/INSTALL.md

Install AKBP into your local Python environment using pip from the repository root.

```bash
python3 -m pip install .
```

--------------------------------

### AKBP Repository Foundation Deliverables

Source: https://github.com/rohitg00/akbp/blob/main/docs/BUILD_PLAN.md

Lists the essential files and directories to be created for the initial repository setup.

```text
README.md
SPEC.md
docs/ARCHITECTURE.md
docs/BUILD_PLAN.md
docs/tool protocol_CONTRACT.md
docs/ADAPTERS.md
docs/BENCHMARK.md
schemas/*.schema.json
examples/*
```

--------------------------------

### Reviewed-Write AKBP Setup

Source: https://github.com/rohitg00/akbp/blob/main/README.md

Command to configure an AKBP adapter for reviewed writes, enabling dry-run previews and approval steps.

```bash
python3 cli/akbp.py --path ./my-kb client-config --name my-adapter --profile reviewed-writes
```

--------------------------------

### Run Rich Context Artifact Example

Source: https://github.com/rohitg00/akbp/blob/main/examples/rich-context-artifact/README.md

Execute the script to run the rich context artifact example from the repository root. This script orchestrates the import, review, and verification processes.

```bash
./examples/rich-context-artifact/run.sh

```

--------------------------------

### Run AKBP Benchmark Script

Source: https://github.com/rohitg00/akbp/blob/main/README.md

Executes the benchmark script located in the examples directory.

```shell
examples/akbp-bench/run.sh
```

--------------------------------

### Example Directory Structure

Source: https://github.com/rohitg00/akbp/blob/main/docs/RICH_CONTEXT_ARTIFACTS.md

Illustrates the directory structure for storing artifacts, including markdown, HTML, and JSONL proposal files.

```text
artifacts/
  handoff.md
  handoff.html
  handoff.proposals.jsonl
```

--------------------------------

### Initialize AKBP Knowledge Base (Manual Path)

Source: https://github.com/rohitg00/akbp/blob/main/docs/GETTING_STARTED.md

Initialize a new AKBP knowledge base in a temporary directory using the manual path setup.

```bash
TMP_KB="$(mktemp -d)/akbp-first-run"
python3 cli/akbp.py --path "$TMP_KB" init --level 0
```

--------------------------------

### Request Agent Capabilities

Source: https://github.com/rohitg00/akbp/blob/main/adapters/terminal-coding-agent/session-start.md

Send this JSON to the agent to get its capabilities. This is the first step in starting a new session.

```json
{"id":"caps","method":"akbp.capabilities","path":"."}
```

--------------------------------

### GitHub Actions Job for Memory CI

Source: https://github.com/rohitg00/akbp/blob/main/examples/memory-ci/README.md

An example GitHub Actions job that sets up Python, installs AKBP, and runs memory validation steps.

```yaml
name: Memory CI

on:
  pull_request:
  push:
    branches: [main]

jobs:
  akbp-memory:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5
        with:
          python-version: '3.12'
      - name: Install AKBP
        run: python -m pip install .
      - name: Validate project memory
        run: |
          akbp --path ./kb lint
          akbp --path ./kb source verify --fail-on-issue
          akbp --path ./kb conformance --level 2
          akbp --path ./kb export --output akbp-bundle.json
          akbp --path ./kb export-check akbp-bundle.json --fail-on-issues
```

--------------------------------

### Create a Knowledge Base

Source: https://github.com/rohitg00/akbp/blob/main/docs/INSTALL.md

Initialize a new knowledge base using the AKBP CLI.

```bash
python3 cli/akbp.py --path ./my-kb init
```

--------------------------------

### Verify Context Freshness with AKBP

Source: https://github.com/rohitg00/akbp/blob/main/docs/PROTOCOL_LANDSCAPE_LEARNINGS.md

This example demonstrates verifying context freshness using AKBP. It proves the green path with `akbp.source.verify` and cited `akbp.session.start`, then verifies that strict startup context fails closed.

```bash
examples/context-freshness-probe/run.sh
```

--------------------------------

### Expected Success Marker for Handoff Example

Source: https://github.com/rohitg00/akbp/blob/main/examples/git-native-agent-handoff/README.md

This text indicates the successful completion of the AKBP git-native handoff example.

```text
AKBP git-native handoff example passed
```

--------------------------------

### AKBP Conformance Command Example

Source: https://github.com/rohitg00/akbp/blob/main/docs/PROTOCOL_STANDARD_GAP_ANALYSIS.md

Suggests the implementation of an 'akbp conformance' command for verifying AKBP compatibility. This command would be central to the conformance suite.

```text
`akbp conformance` command
```

--------------------------------

### Run AKBP Demo Script with Custom Directory

Source: https://github.com/rohitg00/akbp/blob/main/examples/quickstart-demo/README.md

Execute the AKBP quickstart demo script, specifying a custom output directory for the knowledge base. This allows control over where the demo creates its files.

```bash
./examples/quickstart-demo/run.sh /tmp/akbp-demo-kb
```

--------------------------------

### AKBP CLI: Initialize Knowledge Base

Source: https://github.com/rohitg00/akbp/blob/main/README.md

Initialize a new AKBP knowledge base at a specified path with a given level.

```bash
python3 cli/akbp.py --path ./my-kb init --level 0
```

--------------------------------

### Run AKBP Demo Script Directly

Source: https://github.com/rohitg00/akbp/blob/main/examples/quickstart-demo/README.md

Execute the AKBP quickstart demo script directly. This command runs the demo using the default knowledge base directory.

```bash
./examples/quickstart-demo/run.sh
```

--------------------------------

### Conventional Commit Examples

Source: https://github.com/rohitg00/akbp/blob/main/CONTRIBUTING.md

Examples of concise conventional-style commit messages for various types of changes including features, fixes, documentation, and tests.

```text
feat: add knowledge base card adoption path
```

```text
fix: use resolvable schema ids
```

```text
docs: clarify conformance levels
```

```text
test: add schema validation coverage
```

--------------------------------

### Start Session with Gated Context

Source: https://github.com/rohitg00/akbp/blob/main/examples/adapter-lifecycle/README.md

Start a session requiring cited and warning-free context for memory-assisted planning. Use when planning from memory is critical.

```json
{"id":"lifecycle-start-gated","method":"akbp.session.start","path":".","params":{"task":"prepare the release candidate","limit":5,"min_items":1,"require_citations":true,"fail_on_warnings":true}}
```

--------------------------------

### Initialize and Interact with AKBP Tool Server

Source: https://github.com/rohitg00/akbp/blob/main/docs/GETTING_STARTED.md

This snippet demonstrates how to initialize the AKBP tool server and send various commands to it, such as remembering decisions and policies, checking status, and retrieving context. It's useful for testing adapter behavior and understanding AKBP's write-safety features.

```bash
TMP_KB="$(mktemp -d)/akbp-tool-first-run"
python3 cli/akbp.py --path "$TMP_KB" init --level 0

printf '%s\n' \
  '{"id":"preview","method":"akbp.remember","path":"'$TMP_KB'","dry_run":true,"params":{"text":"Decision: release notes must link to validation evidence.","type":"decision"}}' \
  '{"id":"blocked","method":"akbp.remember","path":"'$TMP_KB'","params":{"text":"Unreviewed durable writes should be rejected.","type":"policy"}}' \
  '{"id":"approved","method":"akbp.remember","path":"'$TMP_KB'","approved":true,"params":{"text":"Decision: release notes must link to validation evidence.","type":"decision"}}' \
  '{"id":"status","method":"akbp.status","path":"'$TMP_KB'","params":{"limit":3}}' \
  '{"id":"ctx","method":"akbp.context","path":"'$TMP_KB'","params":{"task":"prepare release notes","limit":5}}' \
  | python3 tool-server/akbp_tool_server.py
```

--------------------------------

### Start AKBP Session

Source: https://github.com/rohitg00/akbp/blob/main/adapters/github-copilot/session-start.md

Use this JSON payload to start an AKBP session. It includes the current coding task and a limit for context retrieval.

```json
{"id":"copilot-session-start","method":"akbp.session.start","path":".","params":{"task":"current coding task","limit":8}}
```

--------------------------------

### Run AKBP Demo and Inspect Claims

Source: https://github.com/rohitg00/akbp/blob/main/docs/PROTOCOL_LANDSCAPE_LEARNINGS.md

Demonstrates how to run a local AKBP demo and inspect the generated claims file. This is useful for understanding AKBP's immediate output and persistence.

```bash
make demo
inspect claims/claims.jsonl
```

--------------------------------

### Terminal Coding Agent Setup

Source: https://github.com/rohitg00/akbp/blob/main/docs/ADAPTERS.md

Setup instructions for a terminal coding agent. This path uses JSONL tool server or CLI for transport.

```text
adapters/terminal-coding-agent/
```

--------------------------------

### Initialize AKBP Knowledge Base

Source: https://github.com/rohitg00/akbp/blob/main/examples/rich-context-artifact/agent-handoff.html

Initializes a new AKBP knowledge base in a specified directory.

```bash
python3 cli/akbp.py --path ./tmp-kb init
```

--------------------------------

### Isolated Local Install Smoke Test

Source: https://github.com/rohitg00/akbp/blob/main/docs/INSTALL.md

Install AKBP into a temporary directory to test without affecting the global Python environment. This verifies importable modules and console scripts.

```bash
TMP=$(mktemp -d)
python3 -m pip install . --target "$TMP/pkg"
PYTHONPATH="$TMP/pkg" python3 -m akbp --path "$TMP/kb" init
PYTHONPATH="$TMP/pkg" python3 -c "import akbp, akbp_tool_server; print('ok')"
PATH="$TMP/pkg/bin:$PATH" PYTHONPATH="$TMP/pkg" akbp --path "$TMP/kb-cli" init
PATH="$TMP/pkg/bin:$PATH" PYTHONPATH="$TMP/pkg" akbp --help
```

--------------------------------

### Start a session with context retrieval

Source: https://github.com/rohitg00/akbp/blob/main/docs/ADAPTER_AUTHOR_QUICKSTART.md

Use `akbp.session.start` as the primary entrypoint for adapter-level session management. This method handles context retrieval and provides a stable `session_id` along with the context pack.

```json
{"id":"session-start-1","method":"akbp.session.start","path":".","params":{"task":"current task goals and constraints","limit":5,"max_chars":4000,"min_items":1,"require_citations":true}}
```

--------------------------------

### akbp.session.start

Source: https://github.com/rohitg00/akbp/blob/main/docs/TOOL_CONTRACT.md

Adapter-level session entrypoint that returns a stable session ID and a cited context pack for the current task. Use at runtime startup.

```APIDOC
## akbp.session.start

### Description
Adapter-level session entrypoint that returns a stable session ID and a cited context pack for the current task. Use at runtime startup.

### Method
Not specified (Tool Call)

### Endpoint
akbp.session.start

### Parameters
#### Input Schema
```json
{
  "id": "session-start-1",
  "method": "akbp.session.start",
  "path": ".",
  "params": {
    "task": "string",
    "limit": "number",
    "max_chars": "number"
  }
}
```
```

--------------------------------

### AKBP Artifact Metadata Example

Source: https://github.com/rohitg00/akbp/blob/main/docs/RICH_CONTEXT_ARTIFACTS.md

Provides a JSON example of metadata associated with a generated artifact. This metadata includes identification, type, source, creation time, and write proposal status.

```json
{
  "id": "artifact_release_review",
  "type": "decision_review",
  "path": "artifacts/release-review.html",
  "derived_from": ["source_release_notes", "claim_release_gate"],
  "created_at": "2026-05-11T00:00:00Z",
  "generator": "akbp-reference",
  "network_access": false,
  "proposes_writes": true
}
```

--------------------------------

### Initialize Tool Server Environment

Source: https://github.com/rohitg00/akbp/blob/main/examples/tool-server-approval-flow/README.md

Initializes the Tool Server environment by creating a temporary knowledge base directory and running the init command.

```bash
TMP_KB="$(mktemp -d)"
python3 cli/akbp.py --path "$TMP_KB" init
```

--------------------------------

### AKBP Session Start Request

Source: https://github.com/rohitg00/akbp/blob/main/docs/OBSIDIAN.md

A JSON request to start an AKBP session, retrieving relevant vault memory for a specified task. The 'limit' parameter controls the amount of memory to retrieve.

```json
{"id":"start","method":"akbp.session.start","path":"./obsidian-vault","params":{"task":"ship the release checklist","limit":5}}
```

--------------------------------

### AKBP Discovery File Example

Source: https://github.com/rohitg00/akbp/blob/main/docs/PROTOCOL_STANDARD_GAP_ANALYSIS.md

Highlights the need for an 'akbp.json' discovery file, detailing supported capabilities, retrieval modes, privacy scopes, schema version, and adapter hints.

```json
`akbp.json` discovery file
```

--------------------------------

### Example JSONL Request for AKBP Context

Source: https://github.com/rohitg00/akbp/blob/main/adapters/claude-code/session-start.md

This is an example of a JSONL request used to establish context for a task within the AKBP system. It specifies the method, path, and parameters for retrieving task-related information.

```json
{"id":"claude-code-context","method":"akbp.context","path":".","params":{"task":"implement the next safe change","limit":8}}
```

--------------------------------

### Run Session Start Harness

Source: https://github.com/rohitg00/akbp/blob/main/docs/ADAPTER_AUTHOR_QUICKSTART.md

Execute the session start harness script to validate `akbp.capabilities`, `akbp.doctor`, and `akbp.session.start` together. This is useful for testing the first trusted context call before enabling write-capable flows.

```bash
examples/session-start-harness/run.sh
```

--------------------------------

### Run AKBP Context Compaction Recovery Example

Source: https://github.com/rohitg00/akbp/blob/main/examples/context-compaction-recovery/README.md

Execute the recovery script from the repository root. This command initiates the AKBP context compaction and recovery process.

```bash
examples/context-compaction-recovery/run.sh
```

--------------------------------

### Check Python 3 Version

Source: https://github.com/rohitg00/akbp/blob/main/docs/TROUBLESHOOTING.md

Verify that Python 3 is installed and accessible in your environment.

```bash
python3 --version
```

--------------------------------

### Clone Repository and View Help

Source: https://github.com/rohitg00/akbp/blob/main/docs/INSTALL.md

Clone the AKBP repository and check the command-line interface help.

```bash
git clone https://github.com/rohitg00/akbp.git
cd akbp
python3 cli/akbp.py --help
```

--------------------------------

### Query AKBP Obsidian Vault

Source: https://github.com/rohitg00/akbp/blob/main/examples/obsidian-vault/README.md

Queries the AKBP Obsidian vault example about how agents should store memory.

```bash
akbp --path examples/obsidian-vault query "how should agents store memory in obsidian"
```