Quick Start

This guide will have you up and running with Cortex TMS in under 5 minutes.

Prerequisites

Node.js 18+ installed
A project directory (new or existing)
(Optional) Claude Code or GitHub Copilot for AI assistance

Installation & Setup

Install Cortex TMS

Choose your preferred installation method:
Terminal window
npm install -g cortex-tms@latest
Terminal window
npx cortex-tms@latest init
Terminal window
pnpm add -g cortex-tms@latest
Terminal window
yarn global add cortex-tms@latest
Global Install Benefits
Installing globally unlocks the cortex shorthand command for faster workflows:
Terminal window
# Instead of typing: cortex-tms status cortex-tms review src/file.ts # You can use: cortex status cortex review src/file.ts
This is especially useful for frequent commands. See roadmap for upcoming features.
Initialize your project

Navigate to your project directory and run:
Terminal window
```
cd your-project
cortex init
# Or: cortex-tms init (both commands work identically)
```
You’ll be prompted to choose:
- Project type: Basic, Full, or Custom
- Features: ADRs, Patterns, Glossary, etc.
Select “Full” to get all features for this tutorial.
Review generated files

Cortex TMS creates this structure:
- Directoryyour-project/
  - CLAUDE.md AI agent instructions
  - NEXT-TASKS.md Current objectives
  - CHANGELOG.md Version history
  - Directorydocs/
    Directorycore/
    PATTERNS.md Code conventions
    GLOSSARY.md Terminology
    Directoryadr/
    0001-example-adr.md
  - Directory.github/
    copilot-instructions.md
Customize for your project

Open CLAUDE.md and update:
- Role: Your AI assistant’s persona
- CLI Commands: Add your test/build commands
- Operational Loop: Modify the workflow if needed
Example customization:
```
## 💻 CLI Commands

- **Test**: `npm test` or `pytest`
- **Lint**: `npm run lint`
- **Build**: `npm run build`
```
Test with Claude Code (if installed)

Open your project in Claude Code:
Terminal window
```
claude-code your-project
```
Claude will automatically read CLAUDE.md and follow your instructions!

Try asking: “What’s the current task?” — Claude will read NEXT-TASKS.md.

Verify Setup

Run the validation command to ensure everything is configured correctly:

cortex validate --strict
# Or: cortex-tms validate --strict

You should see:

✓ CLAUDE.md exists and is valid
✓ NEXT-TASKS.md exists and is well-formed
✓ All ADRs follow naming convention
✓ No dead links in documentation

Project health: EXCELLENT

What’s Next?

Update NEXT-TASKS.md

Edit NEXT-TASKS.md to add your first real task:

## Current Objective

Implement user authentication using JWT tokens.

**Why**: We need secure API access for the mobile app.

**Acceptance Criteria**:
- [ ] JWT token generation on login
- [ ] Token validation middleware
- [ ] Refresh token rotation
- [ ] Tests for auth flow

Create Your First ADR

When you make an architectural decision, document it:

cortex adr new "Use PostgreSQL for user data storage"

This creates docs/adr/0002-use-postgresql-for-user-data-storage.md with a template.

Codify Your Patterns

Edit docs/core/PATTERNS.md to add conventions:

## File Naming

- React components: `PascalCase.tsx`
- Utility functions: `camelCase.ts`
- Test files: `*.test.ts`

Using with AI Agents

Claude Code reads CLAUDE.md automatically. Just open your project:

claude-code .

Copilot reads .github/copilot-instructions.md. Cortex TMS generates this with a reference to your main docs:

See CLAUDE.md for full project conventions.

Cursor supports .cursorrules files. You can copy CLAUDE.md content there:

cp CLAUDE.md .cursorrules

Troubleshooting

Ensure npm global bin is in your PATH:

npm config get prefix

The output should be in your $PATH. If not, add it:

export PATH="$(npm config get prefix)/bin:$PATH"

Both cortex and cortex-tms commands should work after global installation.

Next Steps

Read the Installation guide for advanced setup options
Learn about ADR best practices (coming soon)
Explore template customization (coming soon)

Happy scaffolding! 🚀