Skip to main content

Planning

Planning provides task planning and todo management capabilities.

Quick Start

import { createPlan, createTodoList, TodoItem } from 'praisonai';

// Create a plan
const plan = createPlan({
  name: 'My Project',
  description: 'Build an AI application'
});

// Add steps
plan.addStep({ description: 'Design architecture' });
plan.addStep({ description: 'Implement core features' });
plan.addStep({ description: 'Write tests' });

// Create todo list
const todos = createTodoList('Tasks');
todos.add(new TodoItem({ content: 'Complete documentation' }));
todos.add(new TodoItem({ content: 'Review code', priority: 'high' }));

Plan

interface PlanConfig {
  name: string;
  description?: string;
  metadata?: Record<string, any>;
}

const plan = createPlan({ name: 'My Plan' });
plan.addStep({ description: 'Step 1' });
plan.start();
plan.complete();

TodoList

const todos = createTodoList('My Tasks');

// Add items
const item = new TodoItem({ 
  content: 'Task description',
  priority: 'high'  // 'low' | 'medium' | 'high'
});
todos.add(item);

// Get items
const pending = todos.getPending();
const completed = todos.getCompleted();
const progress = todos.getProgress();

CLI Usage

praisonai-ts planning create "My Project Plan"
praisonai-ts planning todo add "Complete documentation"
praisonai-ts planning todo list --json