@popoverai/dotrequirements 0.12.1 → 0.14.0

package/README.md

@@ -1,10 +1,21 @@
 # dot•requirements
 
-Requirements tracking CLI, test harness, and MCP server for AI-assisted development.
+**One source of truth for what your software should do.**
+Readable. Testable. AI-accessible.
 
-**dot•requirements** treats requirements as discrete, testable data that flows from discovery through implementation to testing. Write requirements as structured Markdown, reference them in tests, and track coverage over time.
+---
+
+Tests prove *something* works—but nobody is certain it's the right something. Requirements live scattered across docs, issue trackers, and people's heads. They drift out of sync with actual code. And AI assistants can't access them at all.
+
+**dot•requirements** closes this gap. Write requirements as structured Markdown, reference them directly in tests, and see coverage update automatically. When a requirement changes, the tests that validate it are one click away.
+
+> **Alpha Software** — Under active development. Please report issues to support@popover.ca.
 
-> **Alpha Software** — This package is under active development and may be unstable or incomplete. We're working toward a stable release, but things may break. Please report issues to support@popover.ca.
+## Who Is This For?
+
+- **Developers** who want tests that prove the right behavior, not just "80% coverage"
+- **Product managers** who want visibility into what's actually being tested
+- **AI-first builders** who want clear requirements for faster, more accurate implementations
 
 ## Installation
 
@@ -32,10 +43,7 @@ Create `*.requirements.md` files in `.requirements/` or colocate them with your
 
 ```markdown
 ---
-projectId: my-project
-version: 1
 document:
-  id: auth-requirements
   title: "Authentication Requirements"
 ---
 
@@ -79,27 +87,6 @@ After running tests, you'll see a coverage report showing which requirements hav
 
 ---
 
-## What Works Locally
-
-The following features work fully offline—no account required:
-
-- Write requirements (`.requirements.md` files)
-- Validate requirements (`dotreq test`)
-- Reference requirements in tests (`requirement()`)
-- Coverage reporting (console output)
-- MCP tools (search, validate, explore)
-
-The following features require a dot•requirements cloud account:
-
-- Sync requirements (`pull` / `push`)
-- Historical coverage tracking
-- AI-powered style checking
-- Team collaboration
-
-To enable cloud features, run `dotreq login`.
-
----
-
 ## CLI Commands
 
 ### `dotreq init`
@@ -148,15 +135,6 @@ dotreq test
 dotreq test --file .requirements/auth.requirements.md
 ```
 
-### `dotreq login` / `logout`
-
-Authenticate with dot•requirements cloud.
-
-```bash
-dotreq login
-dotreq logout
-```
-
 ### `dotreq mcp-setup`
 
 Configure the MCP server for AI assistants (Claude Code, Cursor, etc.).
@@ -175,9 +153,30 @@ dotreq mcp
 
 ---
 
+## What Works Locally
+
+The following features work fully offline—no account required:
+
+- Write requirements (`.requirements.md` files)
+- Validate requirements (`dotreq test`)
+- Reference requirements in tests (`requirement()`)
+- Coverage reporting (console output)
+- MCP tools (search, validate, explore)
+
+The following features require a dot•requirements cloud account:
+
+- Sync requirements (`pull` / `push`)
+- Historical coverage tracking
+- AI-powered style checking
+- Team collaboration
+
+To enable cloud features, run `dotreq link` to connect your project to the cloud.
+
+---
+
 ## Test Harness
 
-The test harness tracks which requirements are exercised by your tests.
+Stop wondering "did we test that?" The test harness tracks which requirements are exercised by your tests and shows gaps instantly.
 
 ### Setup with Vitest
 
@@ -210,6 +209,15 @@ export async function teardown() {
 
 Alternatively, you can use the default export pattern that returns a teardown function—see the [Vitest globalSetup docs](https://vitest.dev/config/globalsetup).
 
+**Customizing output:** `finalize()` accepts options to control verbosity:
+
+```typescript
+await finalize({ showTestedList: true }); // Include tested requirements
+await finalize({ showSummary: false, showUntestedList: false }); // Quiet mode
+```
+
+By default, only untested requirements are shown. See the [test harness docs](https://dotrequirements.io/tools/test-harness) for all options.
+
 ### Setup with Jest
 
 **jest.config.cjs:**
@@ -284,25 +292,29 @@ test(requirement('AUTH-LOGIN-1', 'AUTH-SECURITY-1'), () => {
 
 ### Coverage Reporting
 
+Coverage isn't just a number—it's a map of which features have been tested and which haven't.
+
 #### Local Report
 
 After tests complete, a coverage summary prints to the console:
 
 ```
 === Requirements Coverage Report ===
+
 Total Requirements: 12
 Tested Requirements: 10
 Untested Requirements: 2
 Coverage: 83.3%
 
-Tested:
-  ✓ AUTH-LOGIN-1 (A registered user, Jamie, can log in to their account)
-  ✓ AUTH-LOGIN-1.0 (When Jamie provides a valid username and password...)
-  ...
+✓ Tested Requirements:
+  - AUTH-LOGIN-1: A registered user, Jamie, can log in to their account
+  - AUTH-LOGIN-1.0: When Jamie provides a valid username and password...
+
+✗ Untested Requirements:
+  - AUTH-LOGIN-2: A user with two-factor auth must provide an OTP
+  - AUTH-SECURITY-1: Session tokens expire after 8 hours
 
-Untested:
-  ✗ AUTH-LOGIN-2
-  ✗ AUTH-SECURITY-1
+====================================
 ```
 
 #### Cloud Reporting
@@ -313,12 +325,7 @@ With cloud credentials configured, coverage is automatically reported to dot•r
 - Branch-based coverage (tracks `main`, feature branches, etc.)
 - Query coverage via the MCP server
 
-Configure by adding to `.env.local`:
-
-```bash
-DOTREQUIREMENTS_PROJECT_ID=your-project-id
-DOTREQUIREMENTS_PROJECT_SECRET=your-project-secret
-```
+Run `dotreq link` to connect your project to the cloud and enable coverage reporting.
 
 Cloud reporting is fire-and-forget—it never blocks or fails your tests.
 
@@ -346,10 +353,7 @@ src/components/
 
 ```markdown
 ---
-projectId: my-project
-version: 1
 document:
-  id: unique-doc-id
   title: "Document Title"
 ---
 
@@ -380,7 +384,7 @@ AUTH-LOGIN-2: A user with two-factor auth must provide an OTP
 
 ### Format Details
 
-- **Frontmatter**: YAML metadata (`projectId`, `version`, `document`)
+- **Frontmatter**: YAML metadata (only `document.title` required for push)
 - **Headings**: Optional documentation (not parsed as requirement data)
 - **Fenced blocks**: `dotrequirements` blocks contain structured requirement data
 - **First line**: `KEY: content` — the requirement identifier and summary
@@ -394,7 +398,7 @@ See [MARKDOWN_SCHEMA.md](https://github.com/PopoverAI/dotrequirements/blob/main/
 
 ## MCP Server
 
-The package includes an MCP (Model Context Protocol) server for AI assistant integration. This enables AI coding assistants to search, validate, and work with your requirements.
+AI assistants can read your requirements in context, draft new ones, and verify tests actually validate what they claim to. The MCP server makes this possible through a standard protocol that works with Claude Code, Cursor, and other AI coding assistants.
 
 ### Setup
 
@@ -453,15 +457,16 @@ import '@popoverai/dotrequirements/mcp';
 
 ## Configuration
 
-The CLI stores configuration in `.env.local`:
+The CLI stores project credentials in `.requirements/project-settings.json`:
 
-```bash
-# Project credentials (from dotreq init or login)
-DOTREQUIREMENTS_PROJECT_ID=your-project-id
-DOTREQUIREMENTS_PROJECT_SECRET=your-project-secret
+```json
+{
+  "projectId": "your-project-id",
+  "projectSecret": "your-project-secret"
+}
 ```
 
-The `.env.local` file is automatically added to `.gitignore` during initialization.
+This file is automatically added to `.gitignore` during initialization.
 
 ---
 

package/dist/cli.js

@@ -7,8 +7,6 @@ import { pushCommand } from './commands/push.js';
 import { testCommand } from './commands/test.js';
 import { mcpCommand } from './commands/mcp.js';
 import { mcpSetupCommand } from './commands/mcp-setup.js';
-import { loginCommand } from './commands/login.js';
-import { logoutCommand } from './commands/logout.js';
 import { loadEnvFile } from './utils/env.js';
 import { readFileSync } from 'fs';
 import { fileURLToPath } from 'url';
@@ -78,13 +76,5 @@ program
     .command('mcp-setup')
     .description('Configure MCP server for your AI assistant (Claude Code, Claude Desktop, etc.)')
     .action(wrapCommand(mcpSetupCommand));
-program
-    .command('login')
-    .description('Authenticate with dot•requirements and enable cloud features')
-    .action(wrapCommand(loginCommand));
-program
-    .command('logout')
-    .description('Clear stored authentication tokens')
-    .action(wrapCommand(logoutCommand));
 program.parse();
 //# sourceMappingURL=cli.js.map