Skip to content

goodtekxyz/vibeops

BranchesTags

Repository files navigation

VibeOps

Workflow rails for Cursor-based vibe coding projects.

npm version License: MIT

VibeOps is a local CLI that installs and operates the project structure needed to run Cursor-based vibe coding as reproducible TASKs: AGENTS.md, Cursor rules, project docs, TASK files, agents/prompts/workflows, Git lifecycle helpers, and optional Notion dashboard sync.

VibeOps does not write product code for you. Cursor is the builder. VibeOps keeps the workflow on rails.

What Is VibeOps?

VibeOps is a local CLI for turning an idea into a repository that Cursor agents can work on safely and repeatably.

It gives a project:

  • docs/project/* for product and architecture context.
  • docs/tasks/TASK-*.md as the AI execution source of truth.
  • .cursor/rules/* and AGENTS.md so Cursor knows how to behave.
  • .vibeops/agents, .vibeops/prompts, .vibeops/workflows for reusable agent instructions.
  • MVP workflow: plan → start → build in Cursor → done (Git merge included).
  • Notion metadata sync for a human dashboard.

Why It Exists

Vibe coding is fast, but chat history is a weak source of truth. Without a durable workflow, agents repeat work, drift outside scope, lose decision history, and leave teammates without a dashboard. VibeOps moves the durable context into Git files and uses CLI commands to keep each TASK bounded.

Core Philosophy

  • VibeOps = workflow rail: it structures the work, validates state, and prints prompts.
  • Cursor = builder: Cursor reads the docs/TASKs and writes application code.
  • Git docs/tasks = AI execution source of truth: TASK markdown beats chat memory.
  • Notion = human dashboard: Notion shows metadata and progress, not canonical task bodies.
What Source of truth
AI execution input Git docs/tasks/*.md
Project design/status Git docs/project/*.md
Change and rollback evidence Git commits/branches
Human dashboard Notion Projects/Tasks DB
Not a source of truth Cursor chat, Slack, memory

Installation

VibeOps requires Node.js 20+.

npm install -g @goodtek/vibeops
vibeops --help

The published package is @goodtek/vibeops. The installed CLI command is vibeops.

For local development from this repository:

pnpm install
pnpm build
node dist/cli.js --help

Quick Start

# 1. Install VibeOps workflow files into the current project.
# Interactive mode can also initialize Git and create the first commit.
vibeops init

# Non-interactive Git bootstrap:
vibeops init --git --initial-commit

# 2. LLM planning → brief + TASK-mvp + mvp-build.md (OpenAI, Codex OAuth, or Cursor agent CLI).
vibeops plan

# 3. Task branch for the single MVP TASK.
vibeops start

# 4. Drag .vibeops/generated/mvp-build.md into a new Cursor chat and implement.

# 5. Finish: verify Result/Test Result, merge to main, delete task branch.
vibeops done

# 6. Optional: interactive nudge
vibeops next

# 7. Optional Notion dashboard sync.
vibeops notion init
vibeops notion test
vibeops notion sync --dry-run

Quick Tutorial: Acme Automator

Suppose the idea is: “Build Acme Automator, a SaaS that schedules and runs browser automation jobs for marketing teams.”

mkdir acme-automator
cd acme-automator

vibeops init --name "Acme Automator" --git --initial-commit
vibeops plan --idea "Acme Automator: schedule and run browser automation jobs for marketing teams"
vibeops start
# Drag .vibeops/generated/mvp-build.md into Cursor and build the MVP.
vibeops done

If a Notion dashboard is enabled:

vibeops notion init
vibeops notion test
vibeops notion sync --dry-run
vibeops notion sync

Full Command Flow

vibeops
├─ init
├─ plan
├─ start [mvp]
├─ done [mvp]
├─ next
├─ status
├─ rollback [mvp]
├─ notion { init | test | sync }
└─ github { status | init }

Run any command with --help for the option details.

Features

Project Bootstrapper

vibeops init installs a project operating system: AGENTS.md, .cursor/rules, docs/project, docs/tasks, .vibeops/agents, .vibeops/prompts, .vibeops/workflows, .vibeops.json, and .vibeops.env.example. It is idempotent by default and only overwrites when --force is used.

Interactive Planner

vibeops plan (requires .vibeops.json) runs an LLM discovery session (OpenAI, Codex OAuth, or Cursor Agent CLI), then writes:

  • .vibeops/brief/project-brief.md
  • docs/tasks/TASK-mvp-*.md
  • .vibeops/generated/mvp-build.md — drag this file into Cursor to implement the MVP

Use --from to regenerate MVP artifacts from an edited brief. Use --non-interactive in CI (placeholders only).

MVP Git Rails

  • vibeops start — task branch + Git Context on TASK-mvp
  • vibeops done — verify Result/Test Result, mark Done, merge, Notion sync (when enabled), post-MVP dirty-tree cleanup, next-task LLM suggestion
  • vibeops next — interactive guide (start → build → finish)
  • vibeops rollback — advisory by default; --confirm / --confirm-destructive to execute

Notion Dashboard Sync

notion init/test/sync pushes project + TASK metadata only (not markdown bodies).

Runner Modes

  • Prompt mode (default): VibeOps prints Cursor-ready prompts. Cursor executes the code changes.
  • VibeOps does not call LLM APIs and does not invoke Cursor CLI directly today; it works as a workflow rail around the human + Cursor loop.

Notion Setup

Notion is optional. If enabled:

  • NOTION_TOKEN is the only environment variable VibeOps reads. It lives in .vibeops.env (gitignored) or in process.env.
  • Target IDs live in .vibeops.json, not in .vibeops.env.
  • projectsTargetId / tasksTargetId are preferred resolved data_source IDs.
  • projectsDatabaseId / tasksDatabaseId remain legacy/container fallbacks.
  • notion init uses data_source-first discovery. If no data sources are found, it can search accessible pages, scan 1-depth inline database blocks, then resolve child databases to data source IDs.
  • Legacy NOTION_API_KEY / NOTION_PROJECT_DB / NOTION_TASK_DB environment variables are no longer used. The .vibeops.env.example that vibeops init writes contains only NOTION_TOKEN=.

Required Projects DB properties:

Property Type
Name title
Project ID rich_text
Status status
Local Path rich_text
Git Repo rich_text or url
Current Phase select
Docs Path rich_text
Summary rich_text

Required Tasks DB properties:

Property Type
Name title
Task ID rich_text
Project ID rich_text
Status status
Priority select
MVP Phase select
Git Branch rich_text
Docs Path rich_text
Summary rich_text
Result Summary rich_text

MVP Phase here is a Notion property name kept for compatibility with existing dashboards. It is a free-form label column and is not an internal release-phase tag.

Required Status options:

  • Projects DB: Building, Planning, Paused, Done, Archived
  • Tasks DB: Planned, In Progress, Review, Done, Blocked

VibeOps validates these options in notion test and notion sync --dry-run, but it never creates or mutates Notion schema.

GitHub Setup

GitHub integration runs on top of the GitHub CLI (gh). VibeOps never stores GITHUB_TOKEN — authentication is owned by gh auth login.

  1. Install gh:

    brew install gh
# or follow https://cli.github.com/

  2. Authenticate:

    gh auth login

  3. Probe state:

    vibeops github status

  4. Connect or create a repo interactively:

    # plan only — no gh / git / file mutation
vibeops github init --dry-run

# plan a new public repo
vibeops github init --dry-run --owner <user> --repo <name> --public

# connect to an existing repo by slug or URL
vibeops github init --dry-run --connect <owner>/<repo>
vibeops github init --dry-run --connect https://github.com/<owner>/<repo>.git
vibeops github init --dry-run --connect git@github.com:<owner>/<repo>.git

vibeops github init applies four things in sequence:

  • (optional) gh repo create <owner>/<repo> --public|--private --source=. --remote=origin for new repos.
  • git remote add origin <url> (or git remote set-url) for the --connect path. Existing remotes are never silently overwritten — VibeOps asks first and defaults to No.
  • Updates package.json repository.url, homepage, bugs.url (skip with --no-package-update).
  • Writes the github section of .vibeops.json: enabled, mode = "gh-cli", owner, repo, remote, visibility, url.

VibeOps never runs git push. Push your branch manually with git push -u <remote> <branch>.

Init Git Bootstrap

vibeops init can optionally do the first local Git setup while installing the workflow files. In interactive mode it asks:

  • Initialize Git repository?
  • Use main as default branch?
  • Create initial commit?
  • Initial commit message

For non-interactive setup:

vibeops init --git --initial-commit
vibeops init --git --no-initial-commit
vibeops init --git --default-branch main --commit-message "chore: initialize vibeops project"

Safety rules:

  • Existing Git repositories skip git init.
  • Existing repositories with commits skip the initial commit path.
  • --dry-run runs no Git commands.
  • VibeOps never pushes and never changes remotes during init.
  • Before the initial commit, VibeOps prints how many files will be included.

Before the first commit, vibeops status distinguishes an unborn branch from a detached HEAD:

Git
  branch  main (unborn, no commits yet)
  status  dirty
  hint    create the first commit or run `vibeops init --git --initial-commit`

Status Output

vibeops status summarizes the local project surface only. It never calls the Notion API and never spawns gh. The Notion section reads from .vibeops.env / process.env (for NOTION_TOKEN presence) and .vibeops.json (for target IDs). The GitHub section reads from .vibeops.json. The Package section reads from package.json.

Example output for a fully-configured project:

Git
  branch  main
  status  clean

Notion
  enabled          yes
  token            configured (.vibeops.env)
  projects target  configured
  tasks target     configured
  hint             run `vibeops notion test`

GitHub
  enabled     yes
  mode        gh-cli
  owner/repo  goodtekxyz/vibeops
  remote      origin
  url         https://github.com/goodtekxyz/vibeops

Package
  name     @goodtek/vibeops
  version  0.2.0
  bin      vibeops

For a fresh project that has not been wired to Notion or GitHub yet:

Notion
  enabled          no
  token            missing
  projects target  missing
  tasks target     missing
  hint             run `vibeops notion init`

GitHub
  enabled  no
  hint     run `vibeops github init`

If the project has no package.json, the Package section degrades gracefully:

Package
  package.json missing

vibeops status --json exposes the same surface programmatically, including notion.tokenSource, notion.hasProjectsTarget, notion.hasTasksTarget, the entire github object, and the entire package object. Legacy environment variables (NOTION_API_KEY, NOTION_PROJECT_DB, NOTION_TASK_DB) are no longer surfaced — VibeOps only uses NOTION_TOKEN.

Git Rollback Safety

  • task start records base branch, base commit, and task branch in task state.
  • task check is read-only and reports working tree + committed changes.
  • task done validates TASK Result/Test Result and moves to Review by default.
  • task rollback is advisory unless explicit confirmation flags are supplied.

Agent Workflow

Agents are Markdown files under .vibeops/agents. Use:

vibeops agent list
vibeops agent show builder
vibeops task prompt TASK-001 --agent builder

The default project template includes agents such as orchestrator, planner, architect, builder, reviewer, tester, docs, and recovery.

Packaging / npm Usage

This package exposes the vibeops binary:

{
  "bin": {
    "vibeops": "dist/cli.js"
  }
}

Package contents are limited by package.json#files to built output, templates, and top-level docs/license files. dist/ is generated by pnpm build / prepack and is not committed.

Useful maintainer commands:

pnpm typecheck
pnpm build
pnpm smoke
pnpm pack
pnpm publish --dry-run --access public --no-git-checks

Actual npm publish is a manual release action and is not performed by this repository workflow.

Security Notes

  • .vibeops.env is gitignored and must contain secrets such as NOTION_TOKEN.
  • VibeOps masks tokens in CLI output.
  • Notion test/debug output is token-safe.
  • notion sync --dry-run performs no mutation.
  • task pull --dry-run performs no file or Notion mutation.
  • Notion page bodies are never synced.
  • Git destructive rollback paths require explicit confirmation.
  • github init uses gh CLI auth — VibeOps never stores GITHUB_TOKEN.
  • github init --dry-run runs zero gh / git remote / file mutations and produces only a plan.

Support

Documentation

License

MIT © VibeOps contributors

About

Workflow rails for Cursor-based vibe coding projects.

Resources

Readme

License

MIT license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

2 tags

Packages

 
 
 

Contributors

Languages