my-pi

https://github.com/spences10/my-pi
Admin
A ready-to-run Pi coding agent distribution with MCP, LSP, skills, recall, redaction, telemetry,...
Tokens:117,185
Snippets:745
Trust Score:9.8
License:MIT
Update:6 days ago
Show doc for...
Tokens:
Raw
### Start local development

Source: https://github.com/spences10/my-pi/blob/main/apps/web/README.md

Run these commands from the repository root to install dependencies and start the development server for the web application.

```bash
pnpm install
pnpm --dir apps/web dev
```

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

### Install the package

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-codex-usage/README.md

Use the pi CLI to install the package.

```bash
pi install npm:@spences10/pi-codex-usage
```

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

### Run the full distribution

Source: https://github.com/spences10/my-pi/blob/main/README.md

Execute the complete, opinionated my-pi setup. Do not install the root package using pi install.

```bash
pnpx --allow-build=@google/genai --allow-build=protobufjs my-pi@latest
```

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

### Install individual Pi packages

Source: https://github.com/spences10/my-pi/blob/main/README.md

Install specific extensions if you already have a Pi setup.

```bash
pi install npm:@spences10/pi-lsp
pi install npm:@spences10/pi-mcp
pi install npm:@spences10/pi-redact
```

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

### Install the package

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-kimi-usage/README.md

Use the pi CLI to install the @spences10/pi-kimi-usage package.

```bash
pi install npm:@spences10/pi-kimi-usage
```

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

### Install Pi extensions

Source: https://github.com/spences10/my-pi/blob/main/README.md

Use this command to install selected extensions into a vanilla Pi installation.

```bash
# Bash/Zsh/Fish
pi install npm:@spences10/pi-{context,lsp,team-mode}
```

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

### Install the package

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-coding-preferences/README.md

Use the Pi CLI to install the coding preferences package.

```bash
pi install npm:@spences10/pi-coding-preferences
```

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

### Install pi-git-ui

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-git-ui/README.md

Use the pi install command to add the package to your environment.

```bash
pi install npm:@spences10/pi-git-ui
```

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

### Install pi-sqlite-tools

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-sqlite-tools/README.md

Use the pi CLI to install the package from npm.

```bash
pi install npm:@spences10/pi-sqlite-tools
```

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

### Install from local monorepo

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-confirm-destructive/README.md

Commands for building and installing the package locally from the monorepo.

```bash
pnpm --filter @spences10/pi-confirm-destructive run build
pi install ./packages/pi-confirm-destructive
# or for one run only
pi -e ./packages/pi-confirm-destructive
```

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

### Install pi-svelte-guardrails

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-svelte-guardrails/README.md

Use the pi CLI to install the guardrails package.

```bash
pi install npm:@spences10/pi-svelte-guardrails
```

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

### Install pi-omnisearch via CLI

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-omnisearch/README.md

Use the pi CLI to install the package.

```bash
pi install npm:@spences10/pi-omnisearch
```

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

### Quick start with pnpx

Source: https://github.com/spences10/my-pi/blob/main/README.md

Run the my-pi CLI using pnpx with required build permissions.

```bash
pnpx --allow-build=@google/genai --allow-build=protobufjs my-pi@latest
# or: npx my-pi@latest / bunx my-pi@latest
```

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

### Build and install pi-context locally

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-context/README.md

Commands to build the package and install or run it in the local development environment.

```bash
pnpm --filter @spences10/pi-context run build
pi install ./packages/pi-context
# or for one run only
pi -e ./packages/pi-context
```

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

### Install language servers locally

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-lsp/README.md

Use these commands to install language servers as project-local development dependencies.

```bash
npm install -D typescript svelte-language-server
# or
pnpm add -D typescript svelte-language-server
```

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

### Install pi-nopeek via pi

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-nopeek/README.md

Use the pi CLI to install the package.

```bash
pi install npm:@spences10/pi-nopeek
```

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

### Install pi-themes package

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-themes/README.md

Use the pi CLI to install the @spences10/pi-themes package.

```bash
pi install npm:@spences10/pi-themes
```

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

### Project-local package installation

Source: https://github.com/spences10/my-pi/blob/main/README.md

Install packages locally and view the current Pi configuration.

```bash
pi install -l npm:@spences10/pi-lsp
pi config -l
```

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

### Start the observability dashboard

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-observability/README.md

Commands to start or open the observability dashboard directly.

```bash
pnpx my-pi@latest observability
# or from this package binary
pnpx pi-observability-server
```

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

### Install pi-omnisearch for local development

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-omnisearch/README.md

Commands for building and installing the package locally from the monorepo.

```bash
pnpm --filter @spences10/pi-omnisearch run build
pi install ./packages/pi-omnisearch
# or for one run only
pi -e ./packages/pi-omnisearch
```

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

### Install pi-recall via npm

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-recall/README.md

Use this command to install the package in your environment.

```bash
pi install npm:@spences10/pi-recall
```

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

### Install a custom theme package

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-themes/README.md

Use the pi CLI to install your custom theme package after publishing.

```bash
pi install npm:@your-scope/pi-your-themes
```

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

### Install language servers globally

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-lsp/README.md

Use these commands to install language servers globally on your system PATH.

```bash
npm install -g typescript svelte-language-server
# or
pnpm add -g typescript svelte-language-server
```

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

### Install pi-nopeek for local development

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-nopeek/README.md

Commands for building and installing the package locally from the monorepo.

```bash
pnpm --filter @spences10/pi-nopeek run build
pi install ./packages/pi-nopeek
# or for one run only
pi -e ./packages/pi-nopeek
```

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

### Install pi-harness via npm

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-harness/README.md

Use this command to install the @spences10/pi-harness package.

```bash
pi install npm:@spences10/pi-harness
```

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

### Profile and context configuration example

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-skills/README.md

Shows a JSON configuration with contexts and profiles. Contexts activate profiles based on cwd, github_org, and github_repo predicates. Profiles use include/exclude rules with wildcards and can extend other profiles.

```json
{
	"contexts": [
		{
			"name": "client-workspace",
			"profile": "client-projects",
			"when": {
				"cwd": "~/repos/client-projects/*",
				"github_org": "client-org",
				"github_repo": ["client-org/app"]
			}
		}
	],
	"profiles": {
		"default": { "include": [], "exclude": [] },
		"client-projects": {
			"extends": ["default"],
			"include": ["client-*", "project:*"],
			"exclude": []
		}
	}
}
```

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

### Install the observability package

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-observability/README.md

Use this command to install the observability package via the Pi CLI.

```bash
pi install npm:@spences10/pi-observability
```

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

### Example mcp-policy.json configuration

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-mcp/README.md

Policy file defining activation rules for servers based on GitHub organization, repository, or working directory.

```json
{
	"servers": {
		"pm-platform": {
			"activateWhen": {
				"githubOrg": ["spences10"],
				"githubRepo": ["spences10/my-pi"],
				"cwdPrefix": ["/home/scott/repos/my-pi"]
			}
		}
	}
}
```

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

### Install pi-talk

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-talk/README.md

Use this command to install the pi-talk package via npm.

```bash
pi install npm:@spences10/pi-talk
```

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

### Example MCP configuration

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-sqlite-tools/README.md

Configuration for mcp-sqlite-tools in the ~/.pi/agent/mcp.json file.

```json
{
	"mcpServers": {
		"mcp-sqlite-tools": {
			"command": "npx",
			"args": ["-y", "mcp-sqlite-tools"]
		}
	}
}
```

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

### Setup Talk in Pi

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-talk/README.md

Run this command inside Pi to initiate the setup flow for storing your Deepgram API key.

```text
/talk setup
```

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

### Install @spences10/pi-redact

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-redact/README.md

Use this command to install the package via the Pi CLI.

```bash
pi install npm:@spences10/pi-redact
```

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

### Start Pi distribution

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-observability/README.md

Command to start the latest version of the my-pi distribution.

```bash
pnpx my-pi@latest
```

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

### Example mcp.json configuration

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-mcp/README.md

A typical project-level configuration file defining an MCP server.

```json
{
	"mcpServers": {
		"sqlite": {
			"command": "npx",
			"args": ["-y", "mcp-sqlite-tools", "./data.db"]
		}
	}
}
```

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

### OpenRouter Fusion configuration example

Source: https://github.com/spences10/my-pi/blob/main/README.md

Example JSON configuration for OpenRouter Fusion settings in ~/.pi/agent/my-pi-settings.json.

```json
{"openRouterFusion":{"analysisModels":["deepseek/deepseek-v3.2"],"judgeModel":"~openai/gpt-latest","force":false}}
```

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

### Example tool name

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-mcp/README.md

An example of how a specific sqlite tool is mapped to the Pi tool naming format.

```text
mcp__sqlite__execute_read_query
```

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

### Build and install pi-lsp locally

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-lsp/README.md

Commands for building the package from the monorepo and installing it locally for development or testing.

```bash
pnpm --filter @spences10/pi-lsp run build
pi install ./packages/pi-lsp
# or for one run only
pi -e ./packages/pi-lsp
```

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

### Install pi-telemetry via CLI

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-telemetry/README.md

Use the pi install command to add the @spences10/pi-telemetry package to your project.

```bash
pi install npm:@spences10/pi-telemetry
```

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

### Install pi-lsp via npm

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-lsp/README.md

Use this command to install the pi-lsp package into your project.

```bash
pi install npm:@spences10/pi-lsp
```

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

### Install pi-skills via npm

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-skills/README.md

Use this command to install the pi-skills package into your project.

```bash
pi install npm:@spences10/pi-skills
```

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

### Install pi-starfield via npm

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-starfield/README.md

Use this command to install the package into your Pi environment.

```bash
pi install npm:@spences10/pi-starfield
```

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

### Build and install telemetry package

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-telemetry/README.md

Commands to build the telemetry package and install or run it within the Pi environment.

```bash
pnpm --filter @spences10/pi-telemetry run build
pi install ./packages/pi-telemetry
# or for one run only
pi -e ./packages/pi-telemetry
```

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

### Install pi-mcp via npm

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-mcp/README.md

Use this command to install the package using the pi CLI.

```bash
pi install npm:@spences10/pi-mcp
```

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

### Build and run pi-harness locally

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-harness/README.md

Commands for building the package from the monorepo and installing or running it locally.

```bash
pnpm --filter @spences10/pi-harness run build
pi install ./packages/pi-harness
# or for one run only
pi -e ./packages/pi-harness
```

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

### Local Development Commands

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-talk/README.md

Commands for building and installing the package locally during development.

```bash
pnpm --filter @spences10/pi-talk run build
pi install ./packages/pi-talk
# or for one run only
pi -e ./packages/pi-talk
```

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

### Configure mcp-omnisearch MCP server

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-omnisearch/README.md

Example configuration for the mcp-omnisearch server in ~/.pi/agent/mcp.json.

```json
{
	"mcpServers": {
		"mcp-omnisearch": {
			"command": "npx",
			"args": ["-y", "mcp-omnisearch"]
		}
	}
}
```

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

### Common my-pi CLI usage patterns

Source: https://github.com/spences10/my-pi/blob/main/README.md

Examples of running my-pi in different modes including full TUI, one-shot print, NDJSON output, RPC mode, and the observability dashboard.

```bash
# full TUI
pnpx my-pi@latest

# one-shot print mode
pnpx my-pi@latest "summarize this repo"
pnpx my-pi@latest -P "explicit print mode"

# NDJSON events for scripts/agents
pnpx my-pi@latest --json "list all TODO comments"

# RPC mode for team/agent orchestration
pnpx my-pi@latest --mode rpc

# local live observability dashboard
pnpx my-pi@latest
# then run /observability in the TUI to open the browser dashboard
pnpx my-pi@latest observability
```

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

### Using create_skills_manager from a custom harness

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-skills/README.md

TypeScript example showing how to import skills and create_skills_manager from @spences10/pi-skills. Pass skills as an ExtensionFactory to your Pi runtime. my-pi uses this to enforce built-in skill toggle behavior.

```ts
import skills, { create_skills_manager } from '@spences10/pi-skills';

// pass `skills` as an ExtensionFactory to your Pi runtime
const manager = create_skills_manager();
```

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

### Develop pi-skills locally

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-skills/README.md

Commands for building the package locally from the monorepo or installing it for development/testing.

```bash
pnpm --filter @spences10/pi-skills run build
pi install ./packages/pi-skills
# or for one run only
pi -e ./packages/pi-skills
```

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

### Context Receipt Example

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-context/README.md

Example of a receipt containing source identification, chunk information, and retrieval commands.

```text
First chunk id: ctx_..._0001
context_search query:"..." source_id:"ctx_..."
context_get source_id:"ctx_..." chunk_id:"ctx_..._0001" before:1 after:1
context_export source_id:"ctx_..."
context_list
```

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

### Run command with nopeek

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-nopeek/README.md

Example of using pnpx nopeek to run a command with specific environment variables.

```bash
pnpx nopeek run .env --only DATABASE_URL -- \
  sh -c 'psql "$DATABASE_URL" -c "select 1"'
```

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

### Import starfield in a custom harness

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-starfield/README.md

Example of importing the starfield extension for use in a custom Pi runtime.

```ts
import starfield from '@spences10/pi-starfield';

// Pass starfield as an ExtensionFactory to your Pi runtime.
```

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

### Import omnisearch in a custom harness

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-omnisearch/README.md

Example of importing the package to use as an ExtensionFactory in a Pi runtime.

```ts
import omnisearch from '@spences10/pi-omnisearch';

// pass `omnisearch` as an ExtensionFactory to your Pi runtime
```

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

### Define coding preferences in JSON

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-coding-preferences/README.md

Example configuration for a rule that prevents the use of npm in favor of pnpm. Place this in ~/.pi/agent/coding-preferences.json or .pi/coding-preferences.json.

```json
{
	"rules": [
		{
			"name": "no-npm",
			"toolNames": ["bash"],
			"target": "command",
			"pattern": "^npm\\b",
			"reason": "Use pnpm in this repo."
		}
	]
}
```

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

### Import recall in a custom harness

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-recall/README.md

Example of importing the recall module to use as an ExtensionFactory in a Pi runtime.

```ts
import recall from '@spences10/pi-recall';

// pass `recall` as an ExtensionFactory to your Pi runtime
```

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

### Redaction example

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-redact/README.md

Shows the transformation of a raw GitHub token into a redacted format.

```text
GITHUB_TOKEN=ghp_abcdefghijklmnopqrstuvwxyz1234567890
```

```text
GITH********************[REDACTED:GitHub Token]
```

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

### Validate and build the site

Source: https://github.com/spences10/my-pi/blob/main/apps/web/README.md

Use these commands to perform type checking and build the production-ready site.

```bash
pnpm --dir apps/web check
pnpm --dir apps/web build
```

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

### Benchmark prompt configuration

Source: https://github.com/spences10/my-pi/blob/main/docs/pi-context-benchmark.md

The configuration used to prompt my-pi for the SvelteKit remote functions documentation extraction benchmark.

```text
https://svelte.dev/docs/kit/remote-functions
provider: tavily
extract_depth: advanced
include_raw_contents: true
large_result_mode: inline
```

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

### Configure observability with auth and grouping

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-observability/README.md

Sets the server URL, authentication token, pool, and tags for observability tracking.

```bash
MY_PI_OBSERVABILITY_URL=http://127.0.0.1:43190 \
MY_PI_OBSERVABILITY_TOKEN=dev-token \
MY_PI_OBSERVABILITY_POOL=team-demo \
MY_PI_OBSERVABILITY_TAG=agent-a,experiment-1 \
pi
```

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

### Authenticate with npm

Source: https://github.com/spences10/my-pi/blob/main/docs/releases.md

Log in to the npm registry and verify the currently authenticated user account.

```bash
npm login
npm whoami
```

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

### Default configuration values

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-observability/README.md

Default host and database path settings.

```text
http://127.0.0.1:43190
~/.pi/agent/observability.db
```

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

### Running development scripts with pnpm

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-harness/README.md

Commands for checking, testing, and building the @spences10/pi-harness package.

```bash
pnpm --filter @spences10/pi-harness run check
pnpm --filter @spences10/pi-harness run test
pnpm --filter @spences10/pi-harness run build
```

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

### Execute release workflow

Source: https://github.com/spences10/my-pi/blob/main/docs/releases.md

Run the versioning, formatting, committing, and publishing sequence from the main branch.

```bash
pnpm run version && pnpm run format && git add . && git commit -m "chore: bump version" && pnpm run release
```

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

### Importing the library API

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-footer/README.md

The root API provides the default Pi extension and various rendering and configuration utilities.

```ts
import footer_extension, {
	FOOTER_PRESETS,
	get_current_thinking_level,
	render_footer_status_line,
} from '@spences10/pi-footer';
```

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

### Run development scripts

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-kimi-usage/README.md

Execute check, test, and build scripts for the package using pnpm and Vite+.

```bash
pnpm --filter @spences10/pi-kimi-usage run check
pnpm --filter @spences10/pi-kimi-usage run test
pnpm --filter @spences10/pi-kimi-usage run build
```

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

### Configure custom context settings

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-context/README.md

Use the /context settings command to define custom retention, storage, and capture thresholds.

```text
/context settings custom <days|off> <max-mb|off> [capture-kb] [capture-lines] [purge-on-shutdown]
```

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

### Available /skills commands

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-skills/README.md

List of available commands for managing Pi skills via the command-line interface.

```text
/skills
/skills enable <key|name|pattern>
/skills disable <key|name|pattern>
/skills search <query>
/skills add <owner/repo> <skill[@ref]> [--pin ref|--scope project|--dir path|--force]
/skills update --dry-run
/skills update --all
/skills profile create <name>
/skills profile use <name>
/skills refresh
/skills defaults all-enabled
/skills defaults all-disabled
```

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

### Run development scripts

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-confirm-destructive/README.md

Commands to check, test, and build the package within the monorepo.

```bash
pnpm --filter @spences10/pi-confirm-destructive run check
pnpm --filter @spences10/pi-confirm-destructive run test
pnpm --filter @spences10/pi-confirm-destructive run build
```

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

### Use resume-recall interactively

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-recall/README.md

Commands to find and resume a live session interactively within the Pi interface.

```text
/resume-recall
/resume-recall auth refactor
```

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

### Server environment variables

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-observability/README.md

Environment variables for configuring the observability server.

```bash
MY_PI_OBSERVABILITY_HOST=127.0.0.1
MY_PI_OBSERVABILITY_PORT=43190
MY_PI_OBSERVABILITY_DB=~/.pi/agent/observability.db
MY_PI_OBSERVABILITY_TOKEN_FILE=~/.pi/agent/observability-token
MY_PI_OBSERVABILITY_RETENTION_DAYS=14
MY_PI_OBSERVABILITY_MAX_EVENTS=100000
MY_PI_OBSERVABILITY_MAX_BODY_BYTES=1048576
MY_PI_OBSERVABILITY_DETAIL=detailed # detailed or summary
MY_PI_OBSERVABILITY_TOKEN=dev-token
```

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

### Configure custom observability server URL

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-observability/README.md

Sets the URL for the observability server. Use this when sending events to a custom or already-running server instead of the default local instance.

```bash
MY_PI_OBSERVABILITY_URL=http://127.0.0.1:43190 pi
```

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

### Run Git UI

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-git-ui/README.md

Execute the git-ui command within the Pi interface to launch the Git client.

```text
/git-ui
```

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

### Build and deploy to Cloudflare

Source: https://github.com/spences10/my-pi/blob/main/apps/web/README.md

Build the application and use Wrangler to deploy it to Cloudflare. Ensure you are authenticated with the account that owns the Worker before running these commands.

```bash
pnpm --dir apps/web build
pnpm --dir apps/web exec wrangler deploy
```

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

### Run development scripts

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-themes/README.md

Execute check and build scripts for the package using pnpm.

```bash
pnpm --filter @spences10/pi-themes run check
pnpm --filter @spences10/pi-themes run build
```

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

### Run development scripts

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-codex-usage/README.md

Execute check, test, and build scripts for the package using pnpm.

```bash
pnpm --filter @spences10/pi-codex-usage run check
pnpm --filter @spences10/pi-codex-usage run test
pnpm --filter @spences10/pi-codex-usage run build
```

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

### Synchronize and validate package documentation

Source: https://github.com/spences10/my-pi/blob/main/docs/package-readmes.md

Run these commands to synchronize generated regions from package manifests and verify the integrity of Markdown links and anchors.

```bash
pnpm docs:sync
pnpm docs:check
```

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

### Run development tasks with pnpm

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-observability/README.md

Use these commands to check, test, and build the @spences10/pi-observability package within the monorepo.

```bash
pnpm --filter @spences10/pi-observability run check
pnpm --filter @spences10/pi-observability run test
pnpm --filter @spences10/pi-observability run build
```

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

### Configure Pi theme settings

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-themes/README.md

Set the active theme in the Pi settings JSON file.

```json
{
	"theme": "tokyo-night"
}
```

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

### Pi-Harness CLI Commands

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-harness/README.md

A list of available commands for managing assessments and harnesses within the Pi-Harness system.

```text
/assess <task>
/assess status
/assess approve [harness|direct]
/assess reject
/assess clear
/harness create <task>
/harness run <dir>
/harness review <dir>
/harness status [dir]
/harness use <dir>
/harness clear
```

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

### Local testing commands

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-starfield/README.md

Commands to build and run the package locally for testing purposes.

```bash
pnpm run build
node dist/index.js
```

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

### Run development scripts

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-git-remote/README.md

Commands to check, test, and build the @spences10/pi-git-remote package using pnpm.

```bash
pnpm --filter @spences10/pi-git-remote run check
pnpm --filter @spences10/pi-git-remote run test
pnpm --filter @spences10/pi-git-remote run build
```

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

### load_context_settings_config()

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-context/README.md

Loads the context settings configuration, sharing retention and capture policy.

```APIDOC
## load_context_settings_config()

### Description
Loads the context settings configuration, sharing retention and capture policy.

### Method
Function

### Endpoint
N/A (SDK function)

### Parameters
None

### Response
Returns the context settings configuration.
```

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

### Run development scripts for @spences10/pi-project-trust

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-project-trust/README.md

Commands to check, test, and build the package using pnpm and Vite+.

```bash
pnpm --filter @spences10/pi-project-trust run check
pnpm --filter @spences10/pi-project-trust run test
pnpm --filter @spences10/pi-project-trust run build
```

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

### Define a standalone theme package manifest

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-themes/README.md

Create a package.json file with a pi.themes manifest entry to define a custom theme package.

```json
{
	"name": "@your-scope/pi-your-themes",
	"files": ["themes", "README.md"],
	"pi": {
		"themes": ["./themes"]
	}
}
```

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

### Importing lsp from @spences10/pi-lsp

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-lsp/README.md

Basic import of the lsp object to be passed as an ExtensionFactory to the Pi runtime.

```ts
import lsp from '@spences10/pi-lsp';

// pass `lsp` as an ExtensionFactory to your Pi runtime
```

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

### Integrate telemetry in a custom harness

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-telemetry/README.md

Use create_telemetry_extension to initialize the telemetry instance and pass it as an ExtensionFactory to the Pi runtime.

```ts
import { create_telemetry_extension } from '@spences10/pi-telemetry';

const telemetry = create_telemetry_extension({
	enabled: true,
	db_path: './tmp/evals.db',
	cwd: process.cwd(),
});

// pass `telemetry` as an ExtensionFactory to your Pi runtime
```

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

### LSP Command Interface

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-lsp/README.md

Available commands for managing and inspecting the LSP client state.

```text
/lsp status
/lsp list
/lsp restart all
/lsp restart <language>
```

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

### Package development scripts

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-redact/README.md

Standard scripts for checking, testing, and building the package within the workspace.

```bash
pnpm --filter @spences10/pi-redact run check
pnpm --filter @spences10/pi-redact run test
pnpm --filter @spences10/pi-redact run build
```

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

### Creating a custom LSP extension

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-lsp/README.md

Use create_lsp_extension for harnesses that require their own language-server client factory.

```ts
import { create_lsp_extension } from '@spences10/pi-lsp';

const lsp = create_lsp_extension({ create_client });
```

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

### Select Python language server backend

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-lsp/README.md

Set the MY_PI_LSP_PYTHON_SERVER environment variable to force the use of a specific Python language server.

```bash
MY_PI_LSP_PYTHON_SERVER=pyright pi
```

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

### Run development scripts for @spences10/pi-context

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-context/README.md

Commands to check, test, and build the package using pnpm filters.

```bash
pnpm --filter @spences10/pi-context run check
pnpm --filter @spences10/pi-context run test
pnpm --filter @spences10/pi-context run build
```

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

### CLI Commands for pi-skill-importer

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-skill-importer/README.md

Interactive and direct CLI commands for managing skills. Use /skills as the preferred entry point.

```text
/skills                 # preferred interactive entry point
/skill-importer          # deprecated compatibility UI
/skill-importer list
/skill-importer import <key|name>
/skill-importer sync <key|name>
/skill-importer delete <key|name>
```

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

### Use in a custom harness

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-confirm-destructive/README.md

Import the package and pass it as an ExtensionFactory to your Pi runtime.

```ts
import confirm_destructive from '@spences10/pi-confirm-destructive';

// pass `confirm_destructive` as an ExtensionFactory to your Pi runtime
```

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

### context_list

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-context/README.md

Lists context sources or chunks.

```APIDOC
## context_list

### Description
Lists context sources or chunks.

### Method
Command

### Endpoint
context_list

### Parameters
None documented

### Response
Returns a list of context items.
```

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

### Create reusable trust wrappers with create_project_trust_wrapper

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-project-trust/README.md

Use create_project_trust_wrapper to handle store persistence and legacy entry matching across multiple subject-specific functions.

```ts
import { create_project_trust_wrapper } from '@spences10/pi-project-trust';

const project_config_trust = create_project_trust_wrapper({
	store_filename: 'trusted-example-projects.json',
	legacy_matcher: (entry, subject) => {
		const legacy = entry as { path?: unknown; hash?: unknown };
		return (
			legacy?.path === subject.id && legacy.hash === subject.hash
		);
	},
});
```

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

### Configure starfield mode in settings

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-starfield/README.md

The global configuration file format for setting the starfield mode.

```json
{
	"packages": {
		"pi-starfield": { "mode": "static" }
	}
}
```

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

### Programmatic usage with create_my_pi

Source: https://github.com/spences10/my-pi/blob/main/README.md

Initialize a runtime using the create_my_pi factory function with custom inline extensions.

```typescript
import { create_my_pi, type InlineExtension } from 'my-pi';

const audit_extension: InlineExtension = {
	name: 'audit-events',
	factory(pi) {
		pi.on('agent_start', () => console.log('agent started'));
	},
};

const runtime = await create_my_pi({
	extensionFactories: [audit_extension],
});
```

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

### Configure svelte-guardrails.json

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-svelte-guardrails/README.md

Create a configuration file to tune guardrail behavior, such as enabling or disabling the $effect rule and defining allowed paths.

```json
{
	"blockEffect": true,
	"allow": ["examples/**", "legacy/**"],
	"mode": "block"
}
```

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

### Tool Actions

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-team-mode/README.md

List of available tool actions for interacting with sessions, groups, artifacts, and messages.

```text
session_list
session_send
session_inbox
session_read
session_ack
session_wait
group_create
group_list
group_join
group_add_session
group_send
artifact_create
artifact_get
artifact_list
message_send
message_list
message_wait
message_read
message_ack
```

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

### create_project_trust_wrapper

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-project-trust/README.md

Creates a reusable trust wrapper that handles store path construction, entry checking, legacy entry checking, and persistence delegation. The caller provides store filename and an optional legacy matcher.

```APIDOC
## create_project_trust_wrapper

### Description
Creates a reusable trust wrapper that handles store path construction, entry checking, legacy entry checking, and persistence delegation. The caller provides store filename and an optional legacy matcher.

### Method
function

### Signature
create_project_trust_wrapper(options) => Wrapper

### Parameters
#### options (object) - Required
- **store_filename** (string) - Required - The filename of the trust store.
- **legacy_matcher** (function) - Optional - A function that matches legacy entries against the subject.

### Request Example
```ts
const project_config_trust = create_project_trust_wrapper({
  store_filename: 'trusted-example-projects.json',
  legacy_matcher: (entry, subject) => {
    const legacy = entry as { path?: unknown; hash?: unknown };
    return (
      legacy?.path === subject.id && legacy.hash === subject.hash
    );
  },
});
```

### Response
Returns a wrapper object that can be used for trust decisions.
```

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

### Run development scripts for pi-skills

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-skills/README.md

Commands to execute check, test, and build scripts for the @spences10/pi-skills package using pnpm filters.

```bash
pnpm --filter @spences10/pi-skills run check
pnpm --filter @spences10/pi-skills run test
pnpm --filter @spences10/pi-skills run build
```

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

### Development commands for @spences10/pi-factory

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-factory/README.md

Commands to run checks, tests, and builds for the package using pnpm.

```bash
pnpm --filter @spences10/pi-factory run check
pnpm --filter @spences10/pi-factory run test
pnpm --filter @spences10/pi-factory run build
```

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

### pi-mcp CLI Commands

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-mcp/README.md

List of available commands for the /mcp TUI server manager.

```text
/mcp                         # open the TUI server manager
/mcp manage                  # same as /mcp
/mcp list
/mcp enable <server>
/mcp disable <server>
/mcp connect [server|all]
/mcp backup                  # backup global + project MCP config
/mcp restore [backup-file]   # restore from picker or filename/path
/mcp profile list
/mcp profile save [name]
/mcp profile load [name] [global|project]
/mcp profiles                # saved profile list and actions
```

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

### Run Package Development Scripts

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-tui-modal/README.md

Use pnpm with the --filter flag to execute check, test, and build commands specifically for the @spences10/pi-tui-modal package.

```bash
pnpm --filter @spences10/pi-tui-modal run check
pnpm --filter @spences10/pi-tui-modal run test
pnpm --filter @spences10/pi-tui-modal run build
```

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

### Using pi-talk in a Custom Harness

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-talk/README.md

Import the talk module to use it as an ExtensionFactory within your Pi runtime.

```ts
import talk from '@spences10/pi-talk';

// Pass talk as an ExtensionFactory to your Pi runtime.
```

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

### Run pirecall CLI commands

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-recall/README.md

Common commands for syncing, recalling, searching, and viewing stats for sessions.

```bash
pnpx pirecall sync --json
pnpx pirecall recall "auth refactor" --json
pnpx pirecall search "prompt presets" --json
pnpx pirecall sessions --json
pnpx pirecall stats --json
```

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

### Preview Cloudflare Worker output

Source: https://github.com/spences10/my-pi/blob/main/apps/web/README.md

Preview the site locally after building to verify the Cloudflare Worker output.

```bash
pnpm --dir apps/web preview
```

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

### run_context_eval_cli()

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-context/README.md

Runs context evaluation workflows from the command line.

```APIDOC
## run_context_eval_cli()

### Description
Runs context evaluation workflows from the command line.

### Method
Function

### Endpoint
N/A (SDK function)

### Parameters
None documented

### Response
Runs the evaluation CLI and returns the result.
```

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

### sqlite_pragmas()

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-sqlite-core/README.md

Builds pragma SQL with optional foreign_keys and timeout settings.

```APIDOC
## sqlite_pragmas()

### Description
Builds pragma SQL with optional foreign_keys and timeout settings.

### Method
Function

### Signature
sqlite_pragmas(options?)

### Parameters
- options (object) - Optional - Configuration options.
  - foreign_keys (boolean) - Optional - Enable foreign key constraints.
  - timeout (number) - Optional - Busy timeout in milliseconds.

### Returns
- string - The pragma SQL statement.
```

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

### Import nopeek in custom harness

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-nopeek/README.md

Import the package to use as an ExtensionFactory in a Pi runtime.

```ts
import nopeek from '@spences10/pi-nopeek';

// pass `nopeek` as an ExtensionFactory to your Pi runtime
```

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

### Talk Commands

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-talk/README.md

Available commands for managing the Talk feature.

```text
/talk setup   Store a Deepgram key and enable Talk
/talk on      Enable Talk with the stored or environment key
/talk off     Disable Talk without deleting the stored key
/talk forget  Disable Talk and delete the stored key
/talk status  Show state, key source, and the next action
```

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

### Agent process environment variable

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-observability/README.md

Environment variable for enabling provider attribution.

```bash
MY_PI_OBSERVABILITY_FORWARD_SESSION_ID=true # opt-in provider attribution
```

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

### Run development and build scripts

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-team-mode/README.md

A collection of pnpm commands to execute checks, tests, coverage reports, and build processes for the @spences10/pi-team-mode package.

```bash
pnpm --filter @spences10/pi-team-mode run check:self
pnpm --filter @spences10/pi-team-mode run test:self
pnpm --filter @spences10/pi-team-mode run coverage:self
pnpm --filter @spences10/pi-team-mode run test:pack
pnpm --filter @spences10/pi-team-mode run test:release
pnpm --filter @spences10/pi-team-mode run build
```

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

### get_context_store()

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-context/README.md

Returns the context store instance for direct indexing and tests.

```APIDOC
## get_context_store()

### Description
Returns the context store instance for direct indexing and tests.

### Method
Function

### Endpoint
N/A (SDK function)

### Parameters
None

### Response
Returns the context store instance.
```

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

### Development Scripts

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-git-ui/README.md

Use pnpm with the filter flag to run check, test, or build scripts for the package.

```bash
pnpm --filter @spences10/pi-git-ui run check
pnpm --filter @spences10/pi-git-ui run test
pnpm --filter @spences10/pi-git-ui run build
```

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

### Run package development scripts

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-child-env/README.md

Use pnpm with the --filter flag to execute check, test, and build scripts specifically for the @spences10/pi-child-env package.

```bash
pnpm --filter @spences10/pi-child-env run check
pnpm --filter @spences10/pi-child-env run test
pnpm --filter @spences10/pi-child-env run build
```

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

### Bounded List Retrieval

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-team-mode/README.md

Pagination and filtering behavior for list tool actions.

```APIDOC
## Bounded List Retrieval

List actions (`session_list`, `session_inbox`, `message_list`, `group_list`, `artifact_list`) return a bounded page.

### Parameters
- `limit` (integer) - Optional - Maximum number of records to return. Default is 20, maximum is 100.
- `offset` (integer) - Optional - Offset for pagination to select the next page.
- `global` (boolean) - Optional - Set to true for cross-project retrieval (for `session_list`, `group_list`, `artifact_list`).
- `include_offline` (boolean) - Optional - Set to true to include offline sessions (for `session_list`).
- `from` (string) - Optional - Filter messages by sender (for `session_inbox`, `message_list`).
- `unread_only` (boolean) - Optional - Filter to unread messages (for `session_inbox`, `message_list`).
- `unacknowledged_only` (boolean) - Optional - Filter to unacknowledged messages (for `session_inbox`, `message_list`).
- `include_read` (boolean) - Optional - Include read messages (for `session_inbox`, `message_list`).
- `include_acknowledged` (boolean) - Optional - Include acknowledged messages (for `session_inbox`, `message_list`).
- `mode` (string) - Optional - Set to 'full' for full record detail.

### Response
- `returned_count` (integer) - Number of records returned.
- `total_count` (integer) - Total number of records available.
- `has_more` (boolean) - Whether more records are available.
- `next_offset` (integer) - Offset for the next page.

### Notes
- Default scope is the caller's current project for `session_list`, `group_list`, and `artifact_list`.
- `session_inbox` and `message_list` always read the caller's own inbox and default to unread, unacknowledged messages.
- `mode=full` changes record detail only; it never removes page bounds or implicitly includes read, acknowledged, offline, or global history.
- Broad full-history inbox pages return a warning. When `@spences10/pi-context` is active, any page that still crosses its byte/line budget becomes a searchable sidecar receipt instead of entering model context inline.
```

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

### Telemetry CLI commands

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-telemetry/README.md

A list of available commands for managing and querying telemetry data.

```text
/telemetry status
/telemetry stats
/telemetry query run=<run-id> success=true limit=10
/telemetry export ./telemetry-runs.json suite=smoke
/telemetry on
/telemetry off
/telemetry path
```

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

### context_search

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-context/README.md

Searches the context store using a query and source id.

```APIDOC
## context_search

### Description
Searches the context store using a query and source id.

### Method
Command

### Endpoint
context_search

### Parameters
#### Query Parameters
- **query** (string) - Required - The search query.
- **source_id** (string) - Required - The source identifier.

### Response
Returns search results.
```

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

### Team Slash Commands

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-team-mode/README.md

List of available slash commands for managing team sessions and groups.

```text
/team sessions
/team session list
/team session send <session-id-or-name> <message>
/team session inbox [--all] [--full]
/team session read [message-id...]
/team session ack [message-id...]
/team group list
/team group create <name>
/team group join <group-id-or-name> [alias]
/team group send <group-id-or-name> <message>
```

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

### Upstream pi extension flags

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-observability/README.md

List of equivalent extension flags available when this package is loaded by vanilla upstream pi.

```text
--observability-url
--observability-token
--observability-pool
--observability-tag
--observability-name
--observability-raw
--observability-detail
--observability-forward-session-id
--observability-disable
--no-observability
```

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

### Tool naming format

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-mcp/README.md

The naming convention used to register MCP tools as Pi tools.

```text
mcp__<server>__<tool>
```

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

### Audit and removal workflow commands

Source: https://github.com/spences10/my-pi/blob/main/docs/dependency-overrides.md

Commands to test the removal of a dependency override by updating the lockfile and auditing for vulnerabilities.

```bash
pnpm install --lockfile-only
```

```bash
pnpm audit --audit-level low
```

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

### scan_skill_directory

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-skill-importer/README.md

Scans a skill directory for skills. Exported for packages that need scanner-compatible discovery without duplicating filesystem behavior.

```APIDOC
## scan_skill_directory

### Description
Scans a skill directory for skills. Exported for packages that need scanner-compatible discovery without duplicating filesystem behavior.

### Method
Function

### Signature
scan_skill_directory(directory: string)

### Parameters
- **directory** (string) - Required - The directory to scan.

### Returns
- List of scanned skills.
```

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

### Run development scripts for pi-mcp

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-mcp/README.md

Use pnpm to execute check, test, and build scripts for the @spences10/pi-mcp package within the workspace.

```bash
pnpm --filter @spences10/pi-mcp run check
pnpm --filter @spences10/pi-mcp run test
pnpm --filter @spences10/pi-mcp run build
```

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

### Default database path

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-telemetry/README.md

The default file system path where the telemetry SQLite database is stored.

```text
~/.pi/agent/telemetry.db
```

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

### Default svelte-guardrails configuration

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-svelte-guardrails/README.md

The default configuration settings for the guardrails extension.

```json
{
	"version": 1,
	"blockEffect": true,
	"allow": [],
	"mode": "block"
}
```

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

### Tool Actions

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-team-mode/README.md

Tool actions for session, group, artifact, and message operations.

```APIDOC
## Tool Actions

### session_list
List sessions.

### session_send
Send a session message.

### session_inbox
View session inbox.

### session_read
Read session messages.

### session_ack
Acknowledge session messages.

### session_wait
Wait for session messages.

### group_create
Create a group.

### group_list
List groups.

### group_join
Join a group.

### group_add_session
Add a session to a group.

### group_send
Send a message to a group.

### artifact_create
Create an artifact.

### artifact_get
Get an artifact.

### artifact_list
List artifacts.

### message_send
Send a message (compatibility alias).

### message_list
List messages (compatibility alias).

### message_wait
Wait for messages (compatibility alias).

### message_read
Read messages (compatibility alias).

### message_ack
Acknowledge messages (compatibility alias).
```

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

### import_external_skill

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-skill-importer/README.md

Imports an external skill into the Pi-native skills directory. Review external skills before importing as they can instruct agent behavior and tool use.

```APIDOC
## import_external_skill

### Description
Imports an external skill from an upstream source into the Pi-native skills directory. The importer only owns copied Pi-native skills that contain its metadata.

### Method
Function

### Signature
import_external_skill(keyOrName: string)

### Parameters
- **keyOrName** (string) - Required - The key or name of the skill to import.

### Returns
- Result of the import operation.
```

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

### maybe_store_context_output()

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-context/README.md

Stores context output in the sidecar, used for controlled direct indexing and tests.

```APIDOC
## maybe_store_context_output()

### Description
Stores context output in the sidecar, used for controlled direct indexing and tests.

### Method
Function

### Endpoint
N/A (SDK function)

### Parameters
None documented

### Response
Stores the context output and returns the result.
```

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

### Check redaction statistics

Source: https://github.com/spences10/my-pi/blob/main/packages/pi-redact/README.md

Run this command in the Pi session to see how many values have been redacted.

```text
/redact-stats
```
Tokens:
Raw