@piut/cli 1.0.2 → 2.0.0

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.
Files changed (3) hide show
  1. package/README.md +70 -32
  2. package/dist/cli.js +2073 -9
  3. package/package.json +7 -3
package/README.md CHANGED
@@ -1,16 +1,24 @@
1
- # pıut
1
+ # pıut
2
2
 
3
- **Give every AI tool persistent memory about you.**
3
+ **Your AI context, everywhere. Your config files, backed up.**
4
4
 
5
- pıut is a personal context service that works via [MCP (Model Context Protocol)](https://modelcontextprotocol.io). Connect once, and every AI tool you use — Claude, ChatGPT, Cursor, Copilot, and more — knows who you are, what you're working on, and how you like to work.
5
+ pıut does three things that build on each other:
6
+
7
+ 1. **Host your brain** — Centralized personal context as an MCP server. Connect once, and every AI tool you use knows who you are, how you work, and what matters to you.
8
+ 2. **Keep it updated** — 6 MCP tools let your AI read, write, search, and organize your context automatically. Add a skill reference and it happens without you lifting a finger.
9
+ 3. **Back up your files** — Cloud backup of all your agent config files (CLAUDE.md, .cursorrules, AGENTS.md, etc.) with version history, restore, and cross-machine sync.
6
10
 
7
11
  ## Quick Start
8
12
 
9
13
  ```bash
10
- npx @piut/cli
14
+ npm install -g @piut/cli
15
+ piut
11
16
  ```
12
17
 
13
- That's it. The CLI auto-detects your AI tools and configures them.
18
+ The CLI does everything in one interactive flow:
19
+ - Configures your AI tools with your MCP server
20
+ - Adds skill.md references to your rules files
21
+ - Scans and backs up your agent config files to the cloud
14
22
 
15
23
  Or set up manually:
16
24
 
@@ -36,31 +44,44 @@ See [piut.com/docs](https://piut.com/docs#add-to-ai) for setup guides for 14+ AI
36
44
 
37
45
  ## CLI
38
46
 
39
- Install globally or run with `npx`:
47
+ Install globally, then use the `piut` command:
40
48
 
41
49
  ```bash
42
- npx @piut/cli # Auto-detect and configure AI tools
43
- npx @piut/cli status # Show which tools are connected
44
- npx @piut/cli remove # Remove pıut from selected tools
50
+ npm install -g @piut/cli
51
+
52
+ # Setup & Configuration
53
+ piut # Interactive setup: MCP + skill.md + cloud backup
54
+ piut status # Show which tools are connected
55
+ piut remove # Remove pıut from selected tools
56
+
57
+ # Cloud Backup
58
+ piut sync # Show backup status for current workspace
59
+ piut sync --install # Scan workspace, detect files, upload to cloud
60
+ piut sync --push # Push local changes to cloud
61
+ piut sync --pull # Pull cloud changes to local files
62
+ piut sync --history # Show version history for a file
63
+ piut sync --diff # Show diff between local and cloud
64
+ piut sync --restore # Restore files from cloud backup
45
65
  ```
46
66
 
47
67
  **Options:**
48
68
 
49
69
  ```bash
50
- npx @piut/cli --key pb_... # Pass API key non-interactively
51
- npx @piut/cli --tool cursor # Configure a single tool
52
- npx @piut/cli --skip-skill # Skip skill.md file placement
70
+ piut --key pb_... # Pass API key non-interactively
71
+ piut --tool cursor # Configure a single tool
72
+ piut --skip-skill # Skip skill.md file placement
73
+ piut sync --install --yes # Non-interactive backup setup
53
74
  ```
54
75
 
76
+ You can also use `npx @piut/cli` without installing globally.
77
+
55
78
  **Supported tools:** Claude Code, Claude Desktop, Cursor, Windsurf, GitHub Copilot, Amazon Q, Zed
56
79
 
57
- ## How It Works
80
+ ## The Three Features
58
81
 
59
- 1. **Build your context** — Answer 5 questions or import existing files from your AI tools
60
- 2. **Connect your tools** — Run `npx @piut/cli` or add one config, and every connected AI knows your context
61
- 3. **Stay in sync** — Update your context once, and it's reflected everywhere
82
+ ### 1. Host Your Brain (MCP Server)
62
83
 
63
- Your context is organized into 5 sections:
84
+ Your brain is organized into 5 sections, accessible from every AI tool via MCP:
64
85
 
65
86
  | Section | What it stores |
66
87
  |---------|---------------|
@@ -70,21 +91,9 @@ Your context is organized into 5 sections:
70
91
  | **Projects** | Active, time-bound work with goals and deadlines |
71
92
  | **Memory** | Bookmarks, links, ideas, notes, reference material |
72
93
 
73
- ## Documentation
74
-
75
- | Document | Description |
76
- |----------|-------------|
77
- | [**skill.md**](skill.md) | AI skill file — MCP tools, rate limits, error codes |
78
- | [**Add to your AI**](https://piut.com/docs#add-to-ai) | Setup guides for Claude, ChatGPT, Cursor, Copilot, and more |
79
- | [**API Reference**](https://piut.com/docs#api-examples) | Code examples in cURL, Python, Node.js, Go, and Ruby |
80
- | [**Rate Limits**](https://piut.com/docs#limits) | Limits by plan, error codes, and response headers |
81
- | [**Context Files**](https://piut.com/docs#context-files) | Where to find your existing context in 14 AI platforms |
82
-
83
- All documentation is maintained at [piut.com/docs](https://piut.com/docs) — the interactive version with credential auto-fill and setup guides.
84
-
85
- ## MCP Tools
94
+ ### 2. Keep It Updated (MCP Tools + Skill)
86
95
 
87
- pıut provides 6 tools via MCP:
96
+ 6 tools let your AI read and write your brain:
88
97
 
89
98
  | Tool | Purpose |
90
99
  |------|---------|
@@ -95,7 +104,36 @@ pıut provides 6 tools via MCP:
95
104
  | `update_brain` | AI-powered smart update across sections |
96
105
  | `prompt_brain` | Natural language command (edit, delete, reorganize) |
97
106
 
98
- Full tool documentation: [skill.md](skill.md)
107
+ Add the [skill reference](skill.md) to your rules file and your AI uses these tools automatically.
108
+
109
+ ### 3. Back Up Your Files (Cloud Backup)
110
+
111
+ The CLI scans your workspace for agent config files and backs them up to the cloud:
112
+
113
+ | File | Tool |
114
+ |------|------|
115
+ | `CLAUDE.md` | Claude Code |
116
+ | `AGENTS.md` | Multi-agent |
117
+ | `.cursorrules` | Cursor |
118
+ | `.windsurfrules` | Windsurf |
119
+ | `copilot-instructions.md` | GitHub Copilot |
120
+ | `MEMORY.md` | Claude Code |
121
+ | `SOUL.md` | OpenClaw |
122
+ | `rules/*.md` | Various |
123
+
124
+ Files are encrypted at rest (AES-256-GCM), versioned, and syncable across machines.
125
+
126
+ ## Documentation
127
+
128
+ | Document | Description |
129
+ |----------|-------------|
130
+ | [**skill.md**](skill.md) | AI skill file — MCP tools, rate limits, error codes |
131
+ | [**Add to your AI**](https://piut.com/docs#add-to-ai) | Setup guides for Claude, ChatGPT, Cursor, Copilot, and more |
132
+ | [**API Reference**](https://piut.com/docs#api-examples) | Code examples in cURL, Python, Node.js, Go, and Ruby |
133
+ | [**Cloud Backup**](https://piut.com/docs#cloud-backup) | Cloud backup setup, commands, and sync workflow |
134
+ | [**Rate Limits**](https://piut.com/docs#limits) | Limits by plan, error codes, and response headers |
135
+
136
+ All documentation is maintained at [piut.com/docs](https://piut.com/docs) — the interactive version with credential auto-fill and setup guides.
99
137
 
100
138
  ## Links
101
139