todowrite-cli 0.3.0

CLI interface for ToDoWrite - A tool for managing complex software projects

ToDoWrite CLI

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

Prerequisites

You must first install the todowrite library:

pip install todowrite

Installation

pip install todowrite-cli

For PostgreSQL support:

pip install 'todowrite-cli[postgres]'

Quick Start

Initialize a project

todowrite init --database-path myproject.db

Create a Goal

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

Create a Task

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

Create a Concept

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

Create a Command

todowrite create --command "Build Project" --description "Build the entire project" \
  --run-shell "make build" --artifacts "dist/"

Link Nodes

todowrite link --parent "GOAL-001" --child "TSK-001"

Update Progress

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

View Project Status

todowrite status list
todowrite status show --id "GOAL-001"

Import/Export YAML

todowrite import-yaml --yaml ./configs/
todowrite export-yaml --output ./backup/

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.