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.1.tar.gz (87.5 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.1-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: up_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 87.5 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.1.tar.gz
Algorithm Hash digest
SHA256 b799546fc10c5221bb0010199904a498cf7b66f27357aca6c7ac724d79109552
MD5 622f226d001bfe0e77f23a0cf119d27e
BLAKE2b-256 0a0f5398ea332813dc87344d0b7bc691c28dc0beca453f5df26b3f0db36aad05

See more details on using hashes here.

File details

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

File metadata

  • Download URL: up_cli-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e3e71825ca2a9a4125d212500909d0f6a0d6650a0d3742ca5397633a7a0c5f9e
MD5 f0dcb218646e6a8d8db572241e4ca8fc
BLAKE2b-256 b45c4c67a14a24b021c034b4b7b9cbedb1749612c1afb33f802600a1006d8620

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