Skip to main content

AI-powered project scaffolding with docs, learn, and product-loop systems

Project description

up-cli

img

An AI-powered CLI tool for scaffolding projects with built-in documentation, learning systems, and product-loop workflows designed for use with Claude Code and Cursor AI.

Learned from real practice - Built on insights from 5+ billion tokens of development experience and commercial products. Extracts best practices from chat history, documentation patterns, and proven workflows.

Installation

pip install -e .

Quick Start

# Create new project
up new my-project

# Or initialize in existing project
cd existing-project
up init

Commands

Command Description
up new <name> Create a new project with full scaffolding
up new <name> --template <type> Create project from specific template
up init Initialize up systems in current directory
up init --ai claude Initialize for Claude Code only
up init --ai cursor Initialize for Cursor AI only
up init --systems docs,learn Initialize specific systems only

Usage Examples

Create a new project

# Create a new project with all systems
up new my-saas-app

# Create with a specific template
up new my-api --template fastapi

Initialize in existing project

cd my-existing-project

# Full initialization
up init

# Claude Code focused setup
up init --ai claude

# Only add docs and learn systems
up init --systems docs,learn

Using the Learn System

# Auto-analyze your project and generate insights
/learn auto

# Research a specific topic with web sources
/learn research "authentication patterns"

# Generate a PRD from your codebase
/learn plan

Using the Product Loop

# Start autonomous development loop
./skills/product-loop/start-autonomous.sh

# Run with circuit breaker protection
./skills/product-loop/ralph_hybrid.sh

Systems

1. Docs System

docs/roadmap/vision/      # Product vision
docs/roadmap/phases/      # Phase roadmaps
docs/changelog/           # Progress tracking

2. Learn System

  • /learn auto - Auto-analyze project
  • /learn research [topic] - Research topic
  • /learn plan - Generate PRD

3. Product Loop (SESRC)

  • Circuit breaker (max 3 failures)
  • Checkpoint/rollback
  • Health checks
  • Budget limits

Design Principles & Practices

AI-First Development

Design for AI collaboration, not just human readability.

  • Context-aware scaffolding - Project structures optimized for AI agents to navigate and understand quickly
  • Explicit over implicit - Clear file naming, directory structures, and documentation that AI can parse without ambiguity
  • Prompt-friendly patterns - Code and docs written to be easily referenced in AI conversations
  • Tool integration - Native support for Claude Code skills and Cursor AI rules

Documentation-Driven Development

Documentation is the source of truth, not an afterthought.

  • Docs-first workflow - Write documentation before implementation to clarify intent
  • Living documentation - Docs evolve with the codebase through automated learning systems
  • Knowledge extraction - /learn commands analyze patterns and generate insights from real usage
  • Structured knowledge - Vision, roadmaps, and changelogs in predictable locations for AI and human consumption

Product Loop Patterns (SESRC)

Autonomous development with safety guardrails.

  • Circuit breaker protection - Max 3 consecutive failures before stopping to prevent runaway loops
  • Checkpoint/rollback - Save state before risky operations, restore on failure
  • Health checks - Validate system state between iterations
  • Budget limits - Token and time constraints to prevent unbounded execution
  • Human-in-the-loop - Critical decisions require explicit approval

Core Practices

Practice Description
Incremental delivery Ship small, working increments over big-bang releases
Fail fast, recover faster Detect issues early, rollback automatically
Observable by default Logging, metrics, and state visible to both AI and humans
Convention over configuration Sensible defaults that work out of the box

Development

pip install -e .
pytest

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

up_cli-0.1.0.tar.gz (86.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

up_cli-0.1.0-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file up_cli-0.1.0.tar.gz.

File metadata

  • Download URL: up_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 86.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.4

File hashes

Hashes for up_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fd4628fbd5e2dc6088c97264fe18c1bc775431bddd011f9c12d13a77f06f8dd9
MD5 0fba1554671fbd89003305015bac919d
BLAKE2b-256 73e88ba03accca0658b7e7ad8960b21bfc511ed81890141144c01026a33f879b

See more details on using hashes here.

File details

Details for the file up_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: up_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 10.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.4

File hashes

Hashes for up_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 439c766e6ed8397c20f6f99a2f36729ea1e9241bccedccb06a8d9eb419e46855
MD5 2efebafcbd53262ef412879c0f26a982
BLAKE2b-256 471e19029bb44269f7f4aa1e36f056ea5e759e2bf8c0e71a8e6730ddedee036d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page