atris 1.8.2 → 1.8.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/GETTING_STARTED.md +30 -28
- package/README.md +14 -5
- package/atris/agent_team/navigator.md +7 -7
- package/atris/atris.md +118 -0
- package/atris.md +2 -2
- package/bin/atris.js +32 -17
- package/package.json +1 -1
- package/bin/atris-legacy-backup.js +0 -3611
- package/bin/atris-new.js +0 -161
package/GETTING_STARTED.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
# Getting Started with
|
|
1
|
+
# Getting Started with atrisDev
|
|
2
2
|
|
|
3
|
-
Welcome!
|
|
3
|
+
Welcome! atrisDev gives you a high-quality AI development workflow that works with any coding agent.
|
|
4
4
|
|
|
5
5
|
## What Just Happened?
|
|
6
6
|
|
|
@@ -9,44 +9,46 @@ You ran `atris init` and got this folder structure:
|
|
|
9
9
|
```
|
|
10
10
|
atris/
|
|
11
11
|
├── GETTING_STARTED.md (you are here!)
|
|
12
|
-
├──
|
|
13
|
-
├──
|
|
14
|
-
├── MAP.md (
|
|
15
|
-
|
|
16
|
-
└── agent_team/
|
|
17
|
-
├── navigator.md (pre-built template, ready to use)
|
|
18
|
-
├── executor.md (pre-built template, ready to use)
|
|
19
|
-
└── validator.md (pre-built template, ready to use)
|
|
12
|
+
├── atris.md (atrisDev protocol + specs)
|
|
13
|
+
├── CLAUDE.md (tells agents to follow atrisDev)
|
|
14
|
+
├── MAP.md (navigation - AI will generate)
|
|
15
|
+
└── agent_team/ (agent specs)
|
|
20
16
|
```
|
|
21
17
|
|
|
22
|
-
## Quick Start (
|
|
18
|
+
## Quick Start (2 Steps)
|
|
23
19
|
|
|
24
|
-
### Step 1:
|
|
25
|
-
Open `atris/atris.md` in your editor. This file contains detailed instructions for your AI agent.
|
|
20
|
+
### Step 1: Run atris
|
|
26
21
|
|
|
27
|
-
|
|
28
|
-
|
|
22
|
+
```bash
|
|
23
|
+
atris
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
This loads your workspace context and activates the atrisDev protocol.
|
|
27
|
+
|
|
28
|
+
### Step 2: Describe what you want
|
|
29
|
+
|
|
30
|
+
In your coding agent (Claude Code, Cursor, Windsurf, etc.), just describe what you want to build:
|
|
29
31
|
|
|
30
32
|
```
|
|
31
|
-
|
|
33
|
+
"I want to add dark mode to the settings page"
|
|
34
|
+
"Build a CSV export feature for the dashboard"
|
|
35
|
+
"Refactor the auth system to use OAuth"
|
|
32
36
|
```
|
|
33
37
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
38
|
+
The agent will automatically:
|
|
39
|
+
1. Show you an **atris visualization** (diagram of the plan)
|
|
40
|
+
2. Wait for your approval
|
|
41
|
+
3. Create `docs/features/[name]/idea.md` + `build.md`
|
|
42
|
+
4. Execute step by step
|
|
43
|
+
5. Review and update docs
|
|
39
44
|
|
|
40
|
-
**
|
|
41
|
-
- **navigator.md** - Answers "where is X?" questions
|
|
42
|
-
- **executor.md** - Executes tasks with full context
|
|
43
|
-
- **validator.md** - Validates changes and updates docs
|
|
45
|
+
**Total time: Start building immediately**
|
|
44
46
|
|
|
45
|
-
|
|
47
|
+
## The atrisDev Protocol
|
|
46
48
|
|
|
47
|
-
|
|
49
|
+
When agents see `atris/CLAUDE.md`, they automatically follow the atrisDev workflow. No manual setup needed.
|
|
48
50
|
|
|
49
|
-
|
|
51
|
+
You can also run:
|
|
50
52
|
|
|
51
53
|
```bash
|
|
52
54
|
atris activate
|
package/README.md
CHANGED
|
@@ -1,25 +1,34 @@
|
|
|
1
1
|
# atrisDev
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
High-quality AI development workflow. Works with any coding agent.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install -g
|
|
8
|
+
npm install -g atris
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Quick Start
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
14
|
cd your-project
|
|
15
|
-
atris init
|
|
15
|
+
atris init # Creates atris/ folder
|
|
16
|
+
atris # Loads context, ready to build
|
|
16
17
|
```
|
|
17
18
|
|
|
18
|
-
|
|
19
|
+
Then describe what you want to build. The agent will:
|
|
20
|
+
1. Show you a visualization
|
|
21
|
+
2. Wait for approval
|
|
22
|
+
3. Create `docs/features/[name]/idea.md` + `build.md`
|
|
23
|
+
4. Execute step by step
|
|
24
|
+
5. Review and update docs
|
|
25
|
+
|
|
26
|
+
Works with: Claude Code, Cursor, Windsurf, GitHub Copilot, any agent.
|
|
19
27
|
|
|
20
28
|
## Update
|
|
21
29
|
|
|
22
30
|
```bash
|
|
31
|
+
npm update -g atris
|
|
23
32
|
atris update
|
|
24
33
|
```
|
|
25
34
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# navigator.md — Planner
|
|
1
|
+
# navigator.md — Planner
|
|
2
2
|
|
|
3
3
|
> **Role:** Transform messy human intent into precise execution plans | **Source:** idea.md, MAP.md
|
|
4
4
|
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
When the human gives you an idea (messy, conversational, exploratory):
|
|
10
10
|
|
|
11
11
|
1. **Extract intent** — What are they trying to build? Why?
|
|
12
|
-
2. **Generate
|
|
12
|
+
2. **Generate atris visualization** — Show them exactly what will happen (frontend boxes / backend flow / database tables)
|
|
13
13
|
3. **Confirm** — "Is THIS what you meant?" (y/n)
|
|
14
14
|
4. **Create idea.md** — Save their messy intent to `docs/features/[name]/idea.md`
|
|
15
15
|
5. **Generate build.md** — Create technical spec in `docs/features/[name]/build.md`
|
|
@@ -18,7 +18,7 @@ When the human gives you an idea (messy, conversational, exploratory):
|
|
|
18
18
|
|
|
19
19
|
---
|
|
20
20
|
|
|
21
|
-
##
|
|
21
|
+
## atris Visualization Patterns
|
|
22
22
|
|
|
23
23
|
Use these for 99% of dev work:
|
|
24
24
|
|
|
@@ -51,7 +51,7 @@ Files: route.ts:45, middleware.ts (new)
|
|
|
51
51
|
Migration: add column
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
**Show the
|
|
54
|
+
**Show the visualization. Get confirmation. Build the spec.**
|
|
55
55
|
|
|
56
56
|
---
|
|
57
57
|
|
|
@@ -95,7 +95,7 @@ tests:
|
|
|
95
95
|
|
|
96
96
|
1. **Check docs/features/README.md first** — See what features exist, avoid duplication
|
|
97
97
|
2. **Check MAP.md** — Find exact file:line references for code
|
|
98
|
-
3. **
|
|
98
|
+
3. **Visualization before build.md** — Human confirms visual before technical spec
|
|
99
99
|
4. **Be precise** — Exact files, exact lines, exact changes
|
|
100
100
|
5. **Covers 3 types** — Frontend (boxes), Backend (flows), Database (tables)
|
|
101
101
|
6. **Free-flow works** — Even exploratory conversations go through this flow
|
|
@@ -104,8 +104,8 @@ tests:
|
|
|
104
104
|
- Read docs/features/README.md
|
|
105
105
|
- Search keywords for similar features
|
|
106
106
|
- If exists: extend it, don't duplicate
|
|
107
|
-
- Show
|
|
107
|
+
- Show visualization: "Builds on X, new file Y"
|
|
108
108
|
|
|
109
109
|
---
|
|
110
110
|
|
|
111
|
-
**Navigator =
|
|
111
|
+
**Navigator = Precision before execution.**
|
package/atris/atris.md
CHANGED
|
@@ -466,6 +466,124 @@ Enhanced sync logic with auto-pull and conflict resolution.
|
|
|
466
466
|
|
|
467
467
|
---
|
|
468
468
|
|
|
469
|
+
## Phase 5.2: atrisDev Protocol (Universal Workflow)
|
|
470
|
+
|
|
471
|
+
**The atrisDev Protocol** is a universal workflow that any coding agent can follow to produce high-quality output. When agents follow this protocol, they build features systematically with human approval gates and proper documentation.
|
|
472
|
+
|
|
473
|
+
**This protocol works with ANY agent:** Claude Code, Cursor, Windsurf, GitHub Copilot, or any LLM-based coding assistant.
|
|
474
|
+
|
|
475
|
+
---
|
|
476
|
+
|
|
477
|
+
### How to Use atrisDev
|
|
478
|
+
|
|
479
|
+
**Step 1: Load Context**
|
|
480
|
+
|
|
481
|
+
Run `atris` in your terminal. It outputs a prompt containing:
|
|
482
|
+
- Active work in progress
|
|
483
|
+
- Inbox ideas waiting to be built
|
|
484
|
+
- Recent completions
|
|
485
|
+
- The atrisDev workflow steps
|
|
486
|
+
|
|
487
|
+
**Step 2: Copy the Prompt**
|
|
488
|
+
|
|
489
|
+
Copy the entire output and paste it to your coding agent along with your task description.
|
|
490
|
+
|
|
491
|
+
**Step 3: Agent Follows the Protocol**
|
|
492
|
+
|
|
493
|
+
The agent executes this workflow:
|
|
494
|
+
|
|
495
|
+
---
|
|
496
|
+
|
|
497
|
+
### atrisDev Workflow Steps
|
|
498
|
+
|
|
499
|
+
**1. Show atris Visualization**
|
|
500
|
+
|
|
501
|
+
Before writing any code, the agent creates a visual diagram showing:
|
|
502
|
+
- Architecture/data flow
|
|
503
|
+
- Key components and their interactions
|
|
504
|
+
- Database schema (if applicable)
|
|
505
|
+
- User experience flow (if applicable)
|
|
506
|
+
|
|
507
|
+
**Example:**
|
|
508
|
+
```
|
|
509
|
+
┌─────────────┐
|
|
510
|
+
│ Browser │
|
|
511
|
+
└──────┬──────┘
|
|
512
|
+
│ POST /api/features
|
|
513
|
+
▼
|
|
514
|
+
┌─────────────────┐ ┌──────────────┐
|
|
515
|
+
│ API Handler │─────▶│ Database │
|
|
516
|
+
│ - Validate │ │ - features │
|
|
517
|
+
│ - Transform │◀─────│ - users │
|
|
518
|
+
└─────────────────┘ └──────────────┘
|
|
519
|
+
│
|
|
520
|
+
▼
|
|
521
|
+
┌─────────────────┐
|
|
522
|
+
│ Response JSON │
|
|
523
|
+
└─────────────────┘
|
|
524
|
+
```
|
|
525
|
+
|
|
526
|
+
**2. Wait for Approval**
|
|
527
|
+
|
|
528
|
+
Agent **MUST NOT** proceed until the human confirms the plan is correct.
|
|
529
|
+
|
|
530
|
+
**3. Create idea.md**
|
|
531
|
+
|
|
532
|
+
Path: `docs/features/[feature-name]/idea.md`
|
|
533
|
+
|
|
534
|
+
Contents:
|
|
535
|
+
- **Problem Statement** — What are we solving?
|
|
536
|
+
- **Solution Design** — How will we solve it?
|
|
537
|
+
- **ASCII Diagrams** — Visual representation
|
|
538
|
+
- **Success Criteria** — How do we know it works?
|
|
539
|
+
|
|
540
|
+
**4. Create build.md**
|
|
541
|
+
|
|
542
|
+
Path: `docs/features/[feature-name]/build.md`
|
|
543
|
+
|
|
544
|
+
Contents:
|
|
545
|
+
- **Step-by-step Implementation Plan** — Ordered list of tasks
|
|
546
|
+
- **Files to Change** — Exact file paths and what changes
|
|
547
|
+
- **Testing Strategy** — How to verify each step
|
|
548
|
+
|
|
549
|
+
**5. Execute Step by Step**
|
|
550
|
+
|
|
551
|
+
- Build one step at a time
|
|
552
|
+
- After each step, check alignment with the plan
|
|
553
|
+
- If something doesn't match, stop and adjust
|
|
554
|
+
- Never batch multiple steps without validation
|
|
555
|
+
|
|
556
|
+
**6. Review & Validate**
|
|
557
|
+
|
|
558
|
+
- Run all tests
|
|
559
|
+
- Verify success criteria from idea.md
|
|
560
|
+
- Update `docs/features/README.md` with new feature entry
|
|
561
|
+
- Add completion to journal: `## Completed ✅`
|
|
562
|
+
|
|
563
|
+
---
|
|
564
|
+
|
|
565
|
+
### Why This Works
|
|
566
|
+
|
|
567
|
+
**Benefits of atrisDev Protocol:**
|
|
568
|
+
- **Approval gates prevent wasted work** — Human confirms plan before execution
|
|
569
|
+
- **Documentation is automatic** — idea.md and build.md created as byproducts
|
|
570
|
+
- **Visual thinking reduces miscommunication** — ASCII diagrams force clarity
|
|
571
|
+
- **Step-by-step execution prevents sprawl** — Each step validated before next
|
|
572
|
+
- **Works with any agent** — Protocol is agent-agnostic
|
|
573
|
+
- **Spreads naturally** — Once installed, `atris` becomes the entry point for all dev work
|
|
574
|
+
|
|
575
|
+
**Adoption path:**
|
|
576
|
+
1. Dev installs `atris`: `npm install -g atris`
|
|
577
|
+
2. Initializes project: `atris init`
|
|
578
|
+
3. Runs `atris` to get the protocol prompt
|
|
579
|
+
4. Copies prompt to their preferred agent
|
|
580
|
+
5. Agent follows atrisDev workflow → high-quality output
|
|
581
|
+
6. Dev shares results → others adopt atris
|
|
582
|
+
|
|
583
|
+
**The vision:** Every developer running `atris` gets a structured, high-quality workflow regardless of which coding agent they use. The protocol becomes the standard.
|
|
584
|
+
|
|
585
|
+
---
|
|
586
|
+
|
|
469
587
|
## Phase 6: Future Roadmap (Vision)
|
|
470
588
|
|
|
471
589
|
**See [`ATRIS_NOTES.md`](./ATRIS_NOTES.md) for full roadmap. Preview:**
|
package/atris.md
CHANGED
|
@@ -496,9 +496,9 @@ The agent executes this workflow:
|
|
|
496
496
|
|
|
497
497
|
### atrisDev Workflow Steps
|
|
498
498
|
|
|
499
|
-
**1. Show
|
|
499
|
+
**1. Show atris Visualization**
|
|
500
500
|
|
|
501
|
-
Before writing any code, the agent creates
|
|
501
|
+
Before writing any code, the agent creates a visual diagram showing:
|
|
502
502
|
- Architecture/data flow
|
|
503
503
|
- Key components and their interactions
|
|
504
504
|
- Database schema (if applicable)
|
package/bin/atris.js
CHANGED
|
@@ -91,28 +91,43 @@ function shouldRefreshToken(token, bufferSeconds = TOKEN_REFRESH_BUFFER_SECONDS)
|
|
|
91
91
|
}
|
|
92
92
|
|
|
93
93
|
function showHelp() {
|
|
94
|
-
console.log('Usage: atris <command>');
|
|
95
94
|
console.log('');
|
|
96
|
-
console.log('
|
|
95
|
+
console.log('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━');
|
|
96
|
+
console.log('atrisDev — The new way to build with AI');
|
|
97
|
+
console.log('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━');
|
|
98
|
+
console.log('');
|
|
99
|
+
console.log('Quick Start:');
|
|
100
|
+
console.log('');
|
|
101
|
+
console.log(' 1. atris Load context, start building');
|
|
102
|
+
console.log(' 2. Describe what you want (in your editor or terminal)');
|
|
103
|
+
console.log(' 3. Agent shows visualization, you approve, it builds');
|
|
104
|
+
console.log('');
|
|
105
|
+
console.log('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━');
|
|
106
|
+
console.log('');
|
|
107
|
+
console.log('Setup:');
|
|
97
108
|
console.log(' init - Initialize ATRIS in current project');
|
|
98
|
-
console.log('
|
|
99
|
-
console.log(' status - Show system state (inbox, backlog, completions)');
|
|
100
|
-
console.log(' analytics - Show insights from journal (velocity, trends, patterns)');
|
|
109
|
+
console.log(' update - Update local files to latest version');
|
|
101
110
|
console.log('');
|
|
102
|
-
console.log('
|
|
103
|
-
console.log('
|
|
104
|
-
console.log('
|
|
105
|
-
console.log('
|
|
111
|
+
console.log('Daily workflow:');
|
|
112
|
+
console.log(' atris - Load context and start (recommended)');
|
|
113
|
+
console.log(' log - Add ideas to inbox');
|
|
114
|
+
console.log(' status - See active work and completions');
|
|
115
|
+
console.log(' analytics - View productivity insights');
|
|
106
116
|
console.log('');
|
|
107
|
-
console.log('
|
|
108
|
-
console.log('
|
|
109
|
-
console.log('
|
|
110
|
-
console.log('
|
|
111
|
-
console.log(' whoami - Show current authentication status');
|
|
117
|
+
console.log('Legacy commands (still work, but "atris" is easier):');
|
|
118
|
+
console.log(' plan - Manual planning mode');
|
|
119
|
+
console.log(' do - Execute tasks');
|
|
120
|
+
console.log(' review - Validate work');
|
|
112
121
|
console.log('');
|
|
113
|
-
console.log('
|
|
122
|
+
console.log('Other:');
|
|
123
|
+
console.log(' login - Authenticate with Atris cloud (optional)');
|
|
124
|
+
console.log(' logout - Remove credentials');
|
|
125
|
+
console.log(' whoami - Show auth status');
|
|
114
126
|
console.log(' version - Show ATRIS version');
|
|
115
|
-
console.log(' help - Show this help
|
|
127
|
+
console.log(' help - Show this help');
|
|
128
|
+
console.log('');
|
|
129
|
+
console.log('💡 Tip: Just run "atris" to get started');
|
|
130
|
+
console.log('');
|
|
116
131
|
}
|
|
117
132
|
|
|
118
133
|
// Smart default: if no command, load context and enter brainstorm/planning mode
|
|
@@ -3221,7 +3236,7 @@ async function atrisDevEntry() {
|
|
|
3221
3236
|
console.log('─────────────────────────────────────────────────────────────');
|
|
3222
3237
|
console.log('');
|
|
3223
3238
|
console.log('The atrisDev workflow will automatically:');
|
|
3224
|
-
console.log(' 1. Show
|
|
3239
|
+
console.log(' 1. Show atris visualization');
|
|
3225
3240
|
console.log(' 2. Wait for your approval');
|
|
3226
3241
|
console.log(' 3. Create docs/features/[name]/idea.md + build.md');
|
|
3227
3242
|
console.log(' 4. Execute step by step');
|