cli._new

Page actions AI-ready formats and sharing
Open LLM text
Share with AI
Ask Claude Ask ChatGPT Ask Gemini Ask Copilot
module

chirp new— project scaffolding command.

Creates a new chirp project directory with starter files. Modes include:

  • Default (v2): Auth + dashboard + primitives (filesystem routing, pages/)
  • Minimal (--minimal): app.py…

chirp new— project scaffolding command.

Creates a new chirp project directory with starter files. Modes include:

  • Default (v2): Auth + dashboard + primitives (filesystem routing, pages/)
  • Minimal (--minimal): app.py, templates/index.html
  • SSE (--sse): SSE boilerplate
  • Skill (--skill): signed skill.toolapp + secure stack

cli._new

Name Type Default Description
type —
qualified_name —
element_type —
description —
source_file —
line_number —
is_autodoc —
autodoc_element —
_autodoc_template —
_autodoc_url_path —
_autodoc_page_type —
title —
doc_content_hash —

Symbols on this page

function _has_chirpui

Return True if chirp-ui is installed.

Jump to symbol function _write_app_theme_assets

Write app-owned CSS layers + theme/interaction scripts (#858).

Jump to symbol function _write_scaffold_extras

pyproject.toml, migrations/, optional theme.css hook.

Jump to symbol function _finish_project_metadata

Make each profile's flat source tree explicit to the build backend.

Jump to symbol function create_project

Generate a new chirp project directory.

Creates the project at./<args.name>/relative to cwd. Refuses to overwrite an existing directory.

Jump to symbol function _create_v2

Generate the v2 project layout (auth + dashboard + primitives).

Jump to symbol function _create_shell

Generate project with persistent app shell (topbar, sidebar).

Jump to symbol function _create_minimal

Generate the minimal project layout.

Jump to symbol function _create_ai

Generate AI chat scaffold with tools and SSE activity.

Jump to symbol function _create_skill

Generate a signed skill app (skill.tool + secure stack + Railway).

Jump to symbol function _create_stream

Generate simulated token streaming demo (TemplateStream + EventStream).

Jump to symbol function _create_sse

Generate project with SSE boilerplate.

Jump to symbol
_has_chirpui
function 
def _has_chirpui() -> bool

Return True if chirp-ui is installed.

No parameters.

_write_app_theme_assets
function 
def _write_app_theme_assets(static_dir: Path) -> None

Write app-owned CSS layers + theme/interaction scripts (#858).

Parameters

Name Type Default Description
static_dir Path —
_write_scaffold_extras
function 
def _write_scaffold_extras(project_dir: Path, name: str) -> None

pyproject.toml, migrations/, optional theme.css hook.

Parameters

Name Type Default Description
project_dir Path —
name str —
_finish_project_metadata
function 
def _finish_project_metadata(project_dir: Path, args: argparse.Namespace) -> None

Make each profile's flat source tree explicit to the build backend.

Parameters

Name Type Default Description
project_dir Path —
args argparse.Namespace —
create_project
function 
def create_project(args: argparse.Namespace) -> None

Generate a new chirp project directory.

Creates the project at./<args.name>/relative to cwd. Refuses to overwrite an existing directory.

Parameters

Name Type Default Description
args argparse.Namespace —
_create_v2
function 
def _create_v2(project_dir: Path, name: str, *, with_chirpui: bool) -> None

Generate the v2 project layout (auth + dashboard + primitives).

Parameters

Name Type Default Description
project_dir Path —
name str —
with_chirpui bool —
_create_shell
function 
def _create_shell(project_dir: Path, name: str, *, with_chirpui: bool) -> None

Generate project with persistent app shell (topbar, sidebar).

Parameters

Name Type Default Description
project_dir Path —
name str —
with_chirpui bool —
_create_minimal
function 
def _create_minimal(project_dir: Path, name: str) -> None

Generate the minimal project layout.

Parameters

Name Type Default Description
project_dir Path —
name str —
_create_ai
function 
def _create_ai(project_dir: Path, name: str) -> None

Generate AI chat scaffold with tools and SSE activity.

Parameters

Name Type Default Description
project_dir Path —
name str —
_create_skill
function 
def _create_skill(project_dir: Path, name: str) -> None

Generate a signed skill app (skill.tool + secure stack + Railway).

Parameters

Name Type Default Description
project_dir Path —
name str —
_create_stream
function 
def _create_stream(project_dir: Path, name: str) -> None

Generate simulated token streaming demo (TemplateStream + EventStream).

Parameters

Name Type Default Description
project_dir Path —
name str —
_create_sse
function 
def _create_sse(project_dir: Path, name: str) -> None

Generate project with SSE boilerplate.

Parameters

Name Type Default Description
project_dir Path —
name str —

View source · /home/runner/work/chirp/chirp/site/../src/chirp/cli/_new.py:1