business-os
v0.3.1
Published
Business OS installer, docs, and workflow package
Maintainers
Readme
Business OS
Business OS is a BMAD-style business workflow system for AI agents.
It packages:
- a modular business framework
- installable Codex skills
- matching Claude Code commands
- project-local docs and configuration
- a CLI installer with profile and component selection
Published package:
npx business-os installWhat It Does
Business OS helps a user move from vague business intent to structured business artifacts through reusable workflows such as:
- start a new business
- pivot an existing business
- launch a product or service
- improve sales or marketing
- evaluate expansion
- run SaaS, local-service, premium D2C, and partner-channel specialist paths
The system is designed to work with:
- Codex via
.agents/skills - Claude Code via
.claude/commands
Quick Start
Install the full published package into the current project:
npx business-os install --yes --project .Preview before writing files:
npx business-os install --plan --project .Check an installed project:
npx business-os doctor --project .Update an installed project using its saved manifest:
npx business-os update --project .Install Modes
Full
Installs the whole workflow set.
npx business-os install --yes --project . --profile fullCore
Installs the main start, pivot, launch, growth, and expansion paths.
npx business-os install --yes --project . --profile coreCustom
Installs only the components you choose.
npx business-os install --yes --project . --profile custom --components saas,premium-d2c-launchInstalled Structure
Business OS installs into a project like this:
project/
.business-os/
docs/
_cfg/
install-manifest.json
.agents/
skills/
.claude/
commands/Meaning:
.business-os/docsis the locked baseline document layer.business-os/_cfgis the local override and notes layer.agents/skillsis the Codex execution layer.claude/commandsis the Claude execution layer
Components
Available component ids for --profile custom:
start-corepivotlaunchgrowthexpansionsaaslocal-servicewholesale-readinesspartner-rolloutpremium-d2c-launchpremium-d2c-audit
The installer always includes:
business-os-router
so routing remains available even in custom installs.
CLI
business-os install [--target codex|claude|both] [--profile core|full|custom] [--components LIST] [--project PATH] [--no-docs] [--force] [--yes] [--plan] [--dry-run]
business-os doctor [--project PATH]
business-os update [--project PATH] [--plan] [--dry-run]Key options:
--target: install for Codex, Claude, or both--profile: choosecore,full, orcustom--components: comma-separated component ids for custom installs--plan: show file actions without writing files--no-docs: skip.business-os/docs--yes: noninteractive install
Interactive Installer
If you run install in a TTY without --yes, Business OS opens a guided menu flow for:
- project path
- install target
- install mode
- component selection for custom installs
- docs on/off
- confirmation
This is the current BMAD-like installer layer. It is not a full TUI, but it is now a real guided CLI rather than a flat flag-only installer.
Local Overrides
Project-local overrides live in:
.business-os/_cfg/README.md.business-os/_cfg/local-notes.md
These are scaffolded automatically and are intended to survive updates.
Use them for:
- project-specific routing notes
- local workflow adjustments
- experimental extensions before promoting them into the package
Current Status
Current package version in this repo:
0.3.1
Verified:
- interactive install
- noninteractive install
- core/full/custom profiles
- tarball packaging
- real post-publish
npx [email protected] install - real post-publish
doctor
Release references:
Repo Map
Primary docs:
- docs/business-os-framework.md
- docs/business-os-module-map.md
- docs/business-os-artifact-map.md
- docs/business-os-installer-spec.md
- docs/business-os-package-architecture.md
- docs/business-os-publish-flow.md
Doc index:
Development
Run locally from the repo:
node ./bin/business-os.js install --yes --project /tmp/business-os-dev-smoke
node ./bin/business-os.js doctor --project /tmp/business-os-dev-smoke
node ./bin/business-os.js update --project /tmp/business-os-dev-smoke --planPackage checks:
npm run pack:check
npm run publish:check