Quick Start • The Workspace • Commands • Documentation Engine • Security

The Living Workspace

ListMeBrand connects your codebase directly to your team's product workspace. Instead of maintaining stale wiki pages or outdated readmes, the CLI analyzes code structure, framework routes, configs, and Git commit history to generate up-to-date, publishable product documentation.

How the Workspace Works

 ┌────────────────────────┐
 │   Your Git Repository  │
 └───────────┬────────────┘
             │  npx listmebrand init
             ▼
 ┌─────────────────────────────────────────────────────────────┐
 │  Local Analyzer (100% Client-Side & Zero-Secret Exposure)   │
 │  • Framework Routes & APIs   • Package & Tech Dependencies  │
 │  • Architecture & Configs    • Recent Commits & Changes     │
 └───────────┬─────────────────────────────────────────────────┘
             │
             ├──► Writes local Markdown to `.listmebrand/docs/`
             │
             └──► Syncs to ListMeBrand Workspace (`listmebrand.com`)
                  • Team Collaboration & Living Wiki
                  • AI-Powered Codebase Assistant (`listmebrand ask`)
                  • Automatic Brand & Launch Content Generation

Getting Started: Generate Your Workspace Token

To sync living documentation with your team's cloud dashboard, generate your unique workspace CLI token:

1. Log in to your ListMeBrand Dashboard.
2. Open Workspace Settings (/dashboard/settings).
3. Scroll to the Developer tools section.
4. Click "Create CLI token" to generate a secret key (e.g. lmb_a8f92b...).
5. Copy the token and connect your CLI:

npx listmebrand login lmb_your_token_here

Quick Start

Once authenticated, initialize any codebase:

# 1. Analyze repository and generate living documentation (local + cloud sync)
npx listmebrand init

# 2. Ask architectural and product questions using AI
npx listmebrand ask "How does user authentication work in this codebase?"

# 3. Keep documentation in sync whenever you push new changes
npx listmebrand sync

# 4. Generate local markdown files only (offline mode)
npx listmebrand docs

Or install globally across your machine:

npm install -g listmebrand
listmebrand init

Command Reference

| Command | Description | | :--- | :--- | | listmebrand login <token> | Securely saves your ListMeBrand workspace token in ~/.config/listmebrand/ | | listmebrand init | Scans the repository, generates 9 living docs in .listmebrand/docs, and syncs with cloud | | listmebrand sync | Re-analyzes current changes and pushes updated documentation to your workspace | | listmebrand docs | Generates local documentation in .listmebrand/docs/ without syncing to the cloud | | listmebrand ask "<query>" | Queries your repository using AI with smart context ranking and secrets redaction | | listmebrand --version | Prints the installed CLI version |

Generated Documentation Modules

Every run of listmebrand init or listmebrand docs creates 9 structured, high-signal Markdown documents inside .listmebrand/docs/:

1. product-overview.md: High-level problem statement, project scope, and repository signals.
2. features.md: Detected features extracted from routes and headings.
3. tech-stack.md: Breakdown of runtime frameworks, build tools, and dependencies.
4. architecture.md: Source map, critical configuration files, and project layout.
5. api-docs.md: Discovered endpoints, route handlers, and API entry points.
6. setup-and-deployment.md: Package scripts, local dev workflow, and deployment configs.
7. roadmap-context.md: Analysis of recent code diffs to suggest what to ship or review next.
8. launch-content-ideas.md: Marketing angles, before-and-after copy, and technical launch hooks.
9. changelog.md: Formatted Git commit stream highlighting recent changes.

Security & Privacy

Your code's security is our top priority. The scanner operates with strict privacy guardrails:

• Ignored Folders: node_modules, .git, .next, dist, build, coverage, .firebase, .vercel, vendor.
• Ignored Files: All .env* files, private keys (.pem, .key, .p12, .pfx), credentials, service accounts, and certificates are skipped at the filesystem level.
• On-the-Fly Redaction: Even in normal source files, authorization headers, bearer tokens, passwords, and private key blocks are stripped before context is processed.
• Size Capped: Individual files larger than 250 KB are excluded from analysis to prevent binary and asset parsing.

Project Configuration

When initialized, ListMeBrand stores its local state in .listmebrand/:

.listmebrand/
├── project.json      # Fingerprint, workspace link, and project metadata
└── docs/             # 9 generated Markdown documentation files
    ├── product-overview.md
    ├── features.md
    ├── tech-stack.md
    ├── architecture.md
    ├── api-docs.md
    ├── setup-and-deployment.md
    ├── roadmap-context.md
    ├── launch-content-ideas.md
    └── changelog.md

Tip: We recommend committing .listmebrand/docs/ to your version control so your repository always carries fresh, living product docs.

Supercharge with ListMeBrand Pro

While local markdown generation is 100% free and open-source, subscribing to ListMeBrand Pro or Team connects your repository directly to a powerful living documentation ecosystem:

| Feature | Free | Pro | Team / Enterprise | | :--- | :---: | :---: | :---: | | Local Markdown Docs (.listmebrand/docs) | ✅ | ✅ | ✅ | | Codebase Security & Secrets Redaction | ✅ | ✅ | ✅ | | Real-Time Cloud Workspace Sync | 1 Project | Unlimited | Unlimited | | AI Codebase Assistant (listmebrand ask) | Basic | Unlimited (Fast LLM) | Dedicated Context | | Team Collaboration & Multi-User Access | — | ✅ | Advanced Roles | | Custom Domain Publishing (docs.yourbrand.com) | — | ✅ | Custom SSL & Branding | | Automated GitHub Actions CI/CD Sync | — | ✅ | Priority Queue | | Export Formats (PDF, Notion, OpenAPI, Markdown) | — | ✅ | Custom Webhooks |

👉 Upgrade to ListMeBrand Pro to unlock unlimited live cloud workspaces, automated changelogs, and team collaboration.