Skip to main content
The Projects API allows you to create and manage projects for organizing work.

​
Overview

Projects help you organize related issues around a goal or theme. Unlike cycles (time-boxed), projects are goal-oriented and can span multiple cycles.

​
Endpoints

All project endpoints are available via tRPC at api.projects.*

​
List Projects

api.projects.list(owner: string, repoName: string, options?: {
  status?: 'backlog' | 'planned' | 'in_progress' | 'paused' | 'completed' | 'canceled';
}): Promise<Project[]>
Example: 
const projects = await api.projects.list('myorg', 'myrepo', {
  status: 'in_progress'
});

​
Get Project

api.projects.get(
  owner: string, 
  repoName: string, 
  name: string
): Promise<Project>
Example: 
const project = await api.projects.get('myorg', 'myrepo', 'Auth System');

​
Create Project

api.projects.create(owner: string, repoName: string, data: {
  name: string;
  description?: string;
  leadId?: string;
  startDate?: string;  // ISO date
  targetDate?: string; // ISO date
}): Promise<Project>
Example: 
const project = await api.projects.create('myorg', 'myrepo', {
  name: 'Q1 Features',
  description: 'Feature work for Q1 2024',
  startDate: '2024-01-01T00:00:00Z',
  targetDate: '2024-03-31T00:00:00Z'
});

​
Update Project

api.projects.update(owner: string, repoName: string, name: string, data: {
  name?: string;
  description?: string;
  status?: 'backlog' | 'planned' | 'in_progress' | 'paused' | 'completed' | 'canceled';
  leadId?: string;
  startDate?: string;
  targetDate?: string;
}): Promise<Project>
Example: 
const updated = await api.projects.update('myorg', 'myrepo', 'Auth System', {
  status: 'in_progress'
});

​
Delete Project

api.projects.delete(
  owner: string, 
  repoName: string, 
  name: string
): Promise<void>

​
Get Project Progress

api.projects.getProgress(
  owner: string, 
  repoName: string, 
  name: string
): Promise<{
  total: number;
  completed: number;
  percentage: number;
}>
Example: 
const progress = await api.projects.getProgress('myorg', 'myrepo', 'Auth System');
// { total: 10, completed: 4, percentage: 40 }

​
Get Project Issues

api.projects.getIssues(
  owner: string, 
  repoName: string, 
  name: string
): Promise<Issue[]>

​
Complete Project

api.projects.complete(
  owner: string, 
  repoName: string, 
  name: string
): Promise<Project>
Marks the project as completed and sets completedAt timestamp.

​
Types

​
Project

interface Project {
  id: string;
  repoId: string;
  name: string;
  description?: string;
  status: 'backlog' | 'planned' | 'in_progress' | 'paused' | 'completed' | 'canceled';
  leadId?: string;
  startDate?: string;
  targetDate?: string;
  completedAt?: string;
  createdAt: string;
  updatedAt: string;
}

​
Project Status

StatusDescription
backlogNot yet started
plannedScheduled for future
in_progressCurrently active
pausedTemporarily on hold
completedSuccessfully finished
canceledNo longer needed

​
CLI Usage

# Create project
wit project create "Auth System"

# List projects
wit project list

# View project
wit project view "Auth System"

# Update status
wit project update "Auth System" --status in_progress

# View progress
wit project progress "Auth System"

# Complete project
wit project complete "Auth System"

​
See Also