agent-trajectories 0.5.8 → 0.6.0

package/README.md

@@ -21,7 +21,7 @@ A **trajectory** is the complete story of agent work on a task:
 Works with any task system: Beads, Linear, Jira, GitHub Issues, or standalone. Trajectories are a universal format—like Markdown for documentation.
 
 ### Multiple Storage Backends
-- **File system** (default) - `.trajectories/` directory, git-friendly
+- **File system** (default) - `.agentworkforce/trajectories/` directory, git-friendly
 - **SQLite** - Local indexing and search
 - **PostgreSQL/S3** - For teams and archival
 
@@ -95,17 +95,25 @@ Over time, trajectories become a searchable knowledge base:
 ### CLI
 
 ```bash
-# Install globally (trail command available directly)
+# Run without installing globally
+npx --yes agent-trajectories start "Implement auth module"
+
+# Or install globally if you prefer the short trail command
 npm install -g agent-trajectories
+trail start "Implement auth module"
 
-# Or install locally (requires npx prefix)
+# Or install locally in a project
 npm install agent-trajectories
+npx --no-install trail start "Implement auth module"
+# or
+npm exec -- trail start "Implement auth module"
 ```
 
 ```bash
 # Start tracking a task
 trail start "Implement auth module"
-# (use `npx trail start ...` if installed locally)
+# (for non-global installs, replace `trail` with
+#  `npx --yes agent-trajectories`, `npx --no-install trail`, or `npm exec -- trail`)
 
 # View current status
 trail status
@@ -132,20 +140,20 @@ trail compact --commits abc1234,def5678  # Trajectories matching specific commit
 trail compact --pr 123                # Trajectories mentioning PR #123
 trail compact --since 7d              # Last 7 days
 trail compact --all                   # Everything (including previously compacted)
-trail compact --pr 123 --discard-sources  # Delete source trajectories and update index after compaction
+trail compact --pr 123 --discard-sources  # Delete source trajectories after compaction
 ```
 
 ### Automatic Compaction (GitHub Action)
 
 Add these steps to any workflow that runs on PR merge (e.g., your release or publish flow). Requires `ref: ${{ github.event.pull_request.base.ref }}` and `fetch-depth: 0` on checkout, plus `contents: write` permission.
 
-Use `--discard-sources` when the compacted summary should replace the raw source trajectories. This removes the source JSON/Markdown/trace files and updates `.trajectories/index.json`, reducing future list/search noise.
+Use `--discard-sources` when the compacted summary should replace the raw source trajectories. This removes the source JSON/Markdown/trace files, reducing future list/search noise.
 
 ```yaml
       - name: Compact trajectories
         run: |
           PR_COMMITS=$(git log ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }} --format=%H | paste -sd, -)
-          OUTPUT=".trajectories/compacted/pr-${{ github.event.pull_request.number }}.json"
+          OUTPUT=".agentworkforce/trajectories/compacted/pr-${{ github.event.pull_request.number }}.json"
           if [ -n "$PR_COMMITS" ]; then
             npx agent-trajectories compact --commits "$PR_COMMITS" --output "$OUTPUT" --discard-sources
           else
@@ -153,7 +161,7 @@ Use `--discard-sources` when the compacted summary should replace the raw source
           fi
       - name: Commit compacted trajectories
         run: |
-          git add .trajectories/ || true
+          git add .agentworkforce/trajectories/ || true
           git diff --cached --quiet || \
             (git commit -m "chore: compact trajectories for PR #${{ github.event.pull_request.number }}" && git push)
 ```
@@ -463,7 +471,7 @@ The client manages trajectories with persistent storage.
 ```typescript
 const client = new TrajectoryClient({
   defaultAgent: 'my-agent',    // Default agent name
-  dataDir: '.trajectories',     // Storage directory
+  dataDir: '.',                // Base directory; stores under .agentworkforce/trajectories
   autoSave: true,               // Auto-save after operations
 });
 
@@ -542,7 +550,7 @@ const t = TrajectoryBuilder.create('Task')
 This project is in early development. See [PROPOSAL-trajectories.md](./PROPOSAL-trajectories.md) for the full design document.
 
 **v1.0 (current)**
-- [x] File-based storage (`.trajectories/`)
+- [x] File-based storage (`.agentworkforce/trajectories/`)
 - [x] Core CLI commands (`start`, `decision`, `complete`, `list`, `show`, `export`)
 - [x] Agent Trace spec compliance (`.trace.json` generation)
 - [x] Multi-agent participation tracking