jellycell.cli.commands.prompt

jellycell prompt — emit the agent guide to stdout, or write it to disk.

Spec §10.3 contract: the bytes emitted in stdout mode (jellycell prompt with no flags) are stable across patch versions. Sourced from

file:

docs/agent-guide.md at install time.

With --write the command drops AGENTS.md + a CLAUDE.md stub into the target directory so agentic tools (Cursor, Codex, Copilot, Aider, and Claude Code via the stub) pick up jellycell’s guide at the repo level.

Module Contents

Classes

PromptWriteReport

JSON schema for jellycell prompt --write --json. Spec §10.1 contract.

Functions

prompt

Emit the canonical agent guide, or install it as AGENTS.md + CLAUDE.md.

API

class jellycell.cli.commands.prompt.PromptWriteReport(/, **data: Any)

Bases: pydantic.BaseModel

JSON schema for jellycell prompt --write --json. Spec §10.1 contract.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

schema_version: int

1

written: list[str]

None

skipped: list[str]

None

outer_agents_md: str | None

None

nested: bool

False

jellycell.cli.commands.prompt.prompt(ctx: typer.Context, directory: pathlib.Path | None = typer.Argument(None, help='Target directory (with --write). Defaults to cwd.'), write: bool = typer.Option(False, '--write', help='Write AGENTS.md + CLAUDE.md to DIRECTORY instead of stdout.'), force: bool = typer.Option(False, '--force', help='Overwrite existing AGENTS.md / CLAUDE.md.'), nested: bool = typer.Option(False, '--nested', help='Acknowledge an outer AGENTS.md and write an intentional inner override without --force. Still refuses to clobber an existing target file.'), agents_only: bool = typer.Option(False, '--agents-only', help='Skip the CLAUDE.md stub (AGENTS.md only).')) → None

Emit the canonical agent guide, or install it as AGENTS.md + CLAUDE.md.