@agentplaneorg/core

Core utilities and models used by the agentplane CLI. This package exposes the reusable building blocks for project discovery, config handling, task readme parsing, and task export/linting.

If you are an end-user, install the CLI instead: https://www.npmjs.com/package/agentplane

5-minute start (CLI)

npm install -g agentplane
agentplane init
agentplane quickstart
agentplane task new --title "First task" --description "Describe the change" --priority med --owner ORCHESTRATOR --tag docs
agentplane verify <task-id>
agentplane finish <task-id>

For library usage

Install

npm install @agentplaneorg/core

Requirements

• Node.js >= 20
• ESM-only (type: module)

Usage

import {
  resolveProject,
  loadConfig,
  listTasks,
  readTask,
  buildTasksExportSnapshot,
} from "@agentplaneorg/core";

const project = await resolveProject(process.cwd());
const config = await loadConfig(project.root);
const tasks = await listTasks(project.root);
const task = await readTask(project.root, tasks[0]?.id ?? "");
const snapshot = await buildTasksExportSnapshot(project.root);

console.log(config.data.workflow_mode, task?.id, snapshot.meta.version);

Exported Modules

| Area | Highlights | | ----------------- | -------------------------------------------------------------- | | Project discovery | resolveProject, findGitRoot | | Config | loadConfig, saveConfig, setByDottedKey, validateConfig | | Task README | parseTaskReadme, renderTaskReadme | | Task store | createTask, listTasks, readTask, setTaskDocSection | | Exports | buildTasksExportSnapshot, writeTasksExport, checksums | | Linting | lintTasksFile, lintTasksSnapshot | | Git | getStagedFiles, getUnstagedFiles, base branch helpers | | Commit policy | validateCommitSubject, extractTaskSuffix |

Stability

This package is versioned alongside the CLI and is primarily used by agentplane. The API is stable for current use cases, but expect changes as the CLI evolves.

Docs

• Repository: https://github.com/basilisk-labs/agentplane
• Developer docs: https://github.com/basilisk-labs/agentplane/tree/main/docs

License

MIT