ToDoWrite CLI Interface - (todowrite_cli)

Package Type: cli | Package Name: todowrite-cli | Status: ✅ Published

A command-line interface for managing complex software projects with hierarchical task management through Goals, Tasks, Concepts, and Commands.

🚀 Installation

From PyPI (Recommended)

pip install todowrite-cli

With PostgreSQL Support

pip install 'todowrite-cli[postgres]'

Development Installation

git clone https://github.com/dderyldowney/todowrite.git
cd todowrite/cli_package
pip install -e .[dev]

Version Information

• Current Version: Synchronized with todowrite library
• Version Lock: Always published together with core library
• Dependencies: Requires todowrite library
• Python Requirements: 3.12+

📦 Package Context

This is the CLI interface package of the ToDoWrite monorepo:

todowrite/                          # Monorepo root
├── lib_package/                    # Core library (dependency)
├── cli_package/                   # ✅ This package (CLI Interface)
│   ├── src/todowrite_cli/         # CLI source code
│   └── README.md                  # This documentation
├── web_package/                   # Web application (separate)
└── docs/                          # Project documentation

Package Relationships

• Dependencies: lib_package (todowrite)
• Version Locked: Always published with same version as core library
• Semantic Scope: Uses cli scope for commits

Quick Start

Initialize a project

todowrite init

Create a Goal

todowrite create --layer goal --title "Implement User Authentication" --description "Create secure user authentication system"

Create a Task

todowrite create --layer task --title "Design Database Schema" --description "Design and implement database schema for users"

Create a Concept

todowrite create --layer concept --title "OAuth2 Flow" --description "OAuth2 authentication flow implementation"

Create a Command

todowrite create --layer command --title "Build Project" --description "Build the entire project"

Link Nodes

# Use the update command to add parent-child relationships
todowrite update --id "TSK-001" --add-parent "GOAL-001"

Update Progress

todowrite update --id "TSK-001" --status in_progress --progress 50

View Project Status

todowrite list
todowrite get --id "GOAL-001"

Import/Export YAML

todowrite import-yaml
todowrite export-yaml

Commands

Project Management

• init - Initialize a new project
• create - Create new nodes (goals, tasks, concepts, commands)
• get - Get a specific node by ID
• list - List all nodes with their status
• status show - Show detailed information about a specific node

Status Management

• status update - Update node status and progress
• status complete - Mark a node as completed
• status list - List all nodes with their status

Import/Export

• import-yaml - Import nodes from YAML files
• export-yaml - Export nodes to YAML files
• sync-status - Check synchronization status between YAML files and database

Database Management

• db-status - Show storage configuration and status

Configuration

Configuration is stored in ~/.todowrite/config.yaml:

database:
  default_path: "./todowrite.db"
  storage: "sqlite"  # or "postgresql"

yaml:
  base_path: "./configs"

ui:
  colors: true
  table_format: "fancy_grid"

Development

Setup Development Environment

git clone https://github.com/dderyldowney/todowrite.git
cd todowrite/cli_package
pip install -e .[dev]

Run Tests

pytest tests/

Run Linters

black .
isort .
flake8 .
pyright .

Pre-commit Hooks

pre-commit install

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run tests and linters
5. Submit a pull request

License

MIT License - see LICENSE file for details.