JSPM

projctl

0.2.0
    • ESM via JSPM
    • ES Module Entrypoint
    • Export Map
    • Keywords
    • License
    • Repository URL
    • TypeScript Types
    • README
    • Created
    • Published
    • Downloads 8
    • Score
      100M100P100Q66418F
    • License MIT

    Universal project operating system for AI coding assistants

    Package Exports

      This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (projctl) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

      Readme

      projctl

      Universal project operating system for AI coding assistants.

      English Português

      npm version npm downloads License: MIT Node.js


      What is projctl?

      projctl is a CLI tool that turns any directory into a fully structured AI-ready project. It gives you a Kanban board, agent definitions, slash commands, and a live web dashboard — all version-controlled in .projctl/ alongside your code.

      One project root. Any number of sub-repos and directories underneath. One /projctl slash command to set it all up inside any AI tool.

      my-project/              ← project root (projctl init here)
      ├── backend/             [git · Node]
      ├── frontend/            [git · React]
      ├── mobile/              [git · React Native]
      ├── infra/               [Terraform]
      ├── .projctl/            ← all project state lives here
      │   ├── config.json
      │   ├── board/
      │   │   └── tickets/
      │   ├── agents/
      │   ├── commands/
      │   └── context/
      └── README.md

      Install

      npm install -g projctl

      On install, projctl automatically places a /projctl slash command in:

      • ~/.claude/commands/projctl.md — Claude Code
      • ~/.cursor/commands/projctl.md — Cursor

      Quick Start

      # 1. Go to your project root
      cd ~/my-project
      
      # 2. Initialize
      projctl init
      
      # 3. Open the dashboard
      projctl serve
      # → http://localhost:4242
      
      # 4. Compile for your AI tool
      projctl compile --target claude    # CLAUDE.md + .claude/commands/
      projctl compile --target cursor    # .cursor/commands/ + .cursor/rules/
      projctl compile --target windsurf  # .windsurf/workflows/ + .windsurfrules
      projctl compile --target copilot   # .github/prompts/ + .github/copilot-instructions.md

      Or just type /projctl in Claude Code or Cursor — it detects, initializes, and compiles automatically.


      Features

      📋 Kanban Board

      Ticket management built for AI agents. Every ticket is a Markdown file with frontmatter — readable by humans and machines.

      projctl board add '{"title":"Add auth flow","agent":"developer","scope":"backend"}'
      projctl board ls
      projctl board ls --scope backend --status doing
      projctl board move PRJ-001 doing
      projctl board set PRJ-001 priority p0
      projctl board stat

      📁 Multi-Repo Projects

      A project root can contain any number of sub-directories and git repos. Register them and they appear in the dashboard's Repos tab with live git info.

      projctl repo add ./backend  --name backend
      projctl repo add ./frontend --name frontend
      projctl repo ls
      projctl repo info backend

      🌐 Web Dashboard

      projctl serve   # http://localhost:4242
      Tab Description
      Board Kanban view with real-time SSE updates and scope filter by repo
      Repos Git status per sub-repo: branch, last commit, remote link
      Files Full file tree with tech-stack badges
      Agents AI agent definitions
      Commands Slash commands library
      Context Project knowledge base

      File tree badges: Git, Node, React, Vue, React Native, Python, Go, Rust, Flutter, Docker, Terraform, iOS, Java, PHP.

      🤖 AI Tool Integration

      projctl compiles .projctl/ into the native format of each AI tool:

      Tool Slash Command Context File
      Claude Code .claude/commands/projctl.md CLAUDE.md
      Cursor .cursor/commands/projctl.md .cursor/rules/projctl.md
      Windsurf .windsurf/workflows/projctl.md .windsurfrules
      GitHub Copilot .github/prompts/projctl.prompt.md .github/copilot-instructions.md

      🔧 Global Setup

      projctl setup-global
      # Installs /projctl in Claude Code and Cursor globally
      # Works in any directory, even before projctl init

      Commands

      projctl init               Initialize .projctl/ in the current directory
      projctl board <cmd>        Manage tickets (add, ls, move, set, stat, get)
      projctl repo <cmd>         Manage sub-repos (add, remove, ls, info)
      projctl compile            Compile to tool-specific files
      projctl serve              Start the web dashboard
      projctl setup-global       Install /projctl globally for AI tools
      projctl workspace <cmd>    Manage registered projects
      projctl agent <cmd>        Manage agent definitions
      projctl doctor             Check project health

      .projctl/ Structure

      .projctl/
      ├── config.json          ← project settings (name, prefix, board config, repos)
      ├── activity.jsonl       ← append-only event log
      ├── board/
      │   ├── index.json       ← ticket index (auto-rebuilt from .md files)
      │   └── tickets/
      │       └── PRJ-001-my-ticket.md
      ├── agents/
      │   └── developer.md
      ├── commands/
      │   └── review.md
      └── context/
          ├── decisions/
          └── documents/

      Ticket Format

      ---
      id: PRJ-001
      title: Add authentication
      agent: developer
      scope: backend
      status: doing
      priority: p1
      sprint: sprint-1
      created: 2026-05-04
      updated: 2026-05-04
      completed: null
      depends: null
      tags: auth, security
      ---
      
      # Start
      (Current state before starting)
      
      # Goal — Definition of Done
      - [ ] JWT auth implemented
      - [ ] Tests passing
      
      # Context
      Why this ticket exists.

      Configuration

      {
        "project": {
          "name": "My Project",
          "prefix": "MP",
          "repos": [
            { "name": "backend",  "path": "./backend",  "description": "Node API" },
            { "name": "frontend", "path": "./frontend", "description": "React app" }
          ]
        },
        "board": {
          "statuses": ["backlog", "doing", "review", "done", "cancelled"],
          "priorities": ["p0", "p1", "p2", "p3"],
          "idPadding": 3
        },
        "targets": ["claude", "cursor"]
      }

      Requirements

      • Node.js ≥ 18

      License

      MIT © Felipe Carillo