liteagents 2.4.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.
- package/CHANGELOG.md +441 -0
- package/LICENSE +21 -0
- package/README.md +179 -0
- package/cli.js +230 -0
- package/docs/.gitkeep +1 -0
- package/docs/CONTRIBUTING.md +739 -0
- package/docs/DUAL_PUBLISH_SUMMARY.md +177 -0
- package/docs/ERROR_HANDLING_IMPLEMENTATION.md +327 -0
- package/docs/GITHUB_PACKAGES.md +181 -0
- package/docs/GITHUB_SETUP.md +158 -0
- package/docs/INSTALLATION_DEMO.md +691 -0
- package/docs/INSTALLATION_LOCATIONS.md +299 -0
- package/docs/INSTALLER_GUIDE.md +1586 -0
- package/docs/INTEGRATION_ISSUES_9.1.md +341 -0
- package/docs/KNOWLEDGE_BASE.md +727 -0
- package/docs/MIGRATION.md +384 -0
- package/docs/PACKAGE_BASELINE.md +557 -0
- package/docs/PACKAGE_VALIDATION_REPORT.md +427 -0
- package/docs/PASS_INTEGRATION.md +307 -0
- package/docs/PASS_QUICK_START.md +150 -0
- package/docs/PRIVACY.md +203 -0
- package/docs/PUBLISHING.md +494 -0
- package/docs/QUICK-START.md +318 -0
- package/docs/RELEASE_NOTES_1.2.0.md +323 -0
- package/docs/SECURITY.md +317 -0
- package/docs/SILENT_MODE_GUIDE.md +526 -0
- package/docs/SKILLS_CONVERSION.md +154 -0
- package/docs/TESTING.md +582 -0
- package/docs/TEST_COVERAGE.md +347 -0
- package/docs/TROUBLESHOOTING.md +788 -0
- package/docs/UPDATED_VARIANT_CONFIGURATION.md +274 -0
- package/docs/VARIANT_CONFIGURATION.md +440 -0
- package/installer/cli.js +761 -0
- package/installer/installation-engine.js +1536 -0
- package/installer/package-manager.js +640 -0
- package/installer/path-manager.js +427 -0
- package/installer/report-template.js +298 -0
- package/installer/verification-system.js +274 -0
- package/package.json +83 -0
- package/packages/ampcode/AGENT.md +58 -0
- package/packages/ampcode/README.md +17 -0
- package/packages/ampcode/agents/1-create-prd.md +175 -0
- package/packages/ampcode/agents/2-generate-tasks.md +190 -0
- package/packages/ampcode/agents/3-process-task-list.md +225 -0
- package/packages/ampcode/agents/code-developer.md +198 -0
- package/packages/ampcode/agents/context-builder.md +142 -0
- package/packages/ampcode/agents/feature-planner.md +199 -0
- package/packages/ampcode/agents/market-researcher.md +89 -0
- package/packages/ampcode/agents/orchestrator.md +116 -0
- package/packages/ampcode/agents/quality-assurance.md +115 -0
- package/packages/ampcode/agents/system-architect.md +135 -0
- package/packages/ampcode/agents/ui-designer.md +184 -0
- package/packages/ampcode/commands/brainstorming.md +56 -0
- package/packages/ampcode/commands/code-review.md +107 -0
- package/packages/ampcode/commands/condition-based-waiting/example.ts +158 -0
- package/packages/ampcode/commands/condition-based-waiting.md +122 -0
- package/packages/ampcode/commands/debug.md +20 -0
- package/packages/ampcode/commands/docs-builder/templates.md +572 -0
- package/packages/ampcode/commands/docs-builder.md +106 -0
- package/packages/ampcode/commands/explain.md +18 -0
- package/packages/ampcode/commands/git-commit.md +14 -0
- package/packages/ampcode/commands/optimize.md +20 -0
- package/packages/ampcode/commands/refactor.md +21 -0
- package/packages/ampcode/commands/review.md +18 -0
- package/packages/ampcode/commands/root-cause-tracing/find-polluter.sh +63 -0
- package/packages/ampcode/commands/root-cause-tracing.md +176 -0
- package/packages/ampcode/commands/security.md +21 -0
- package/packages/ampcode/commands/ship.md +18 -0
- package/packages/ampcode/commands/skill-creator/scripts/init_skill.py +303 -0
- package/packages/ampcode/commands/skill-creator/scripts/package_skill.py +110 -0
- package/packages/ampcode/commands/skill-creator/scripts/quick_validate.py +65 -0
- package/packages/ampcode/commands/skill-creator.md +211 -0
- package/packages/ampcode/commands/stash.md +45 -0
- package/packages/ampcode/commands/systematic-debugging.md +297 -0
- package/packages/ampcode/commands/test-driven-development.md +390 -0
- package/packages/ampcode/commands/test-generate.md +18 -0
- package/packages/ampcode/commands/testing-anti-patterns.md +304 -0
- package/packages/ampcode/commands/verification-before-completion.md +152 -0
- package/packages/ampcode/settings.json +13 -0
- package/packages/ampcode/variants.json +8 -0
- package/packages/claude/CLAUDE.md +58 -0
- package/packages/claude/README.md +23 -0
- package/packages/claude/agents/1-create-prd.md +175 -0
- package/packages/claude/agents/2-generate-tasks.md +190 -0
- package/packages/claude/agents/3-process-task-list.md +225 -0
- package/packages/claude/agents/code-developer.md +198 -0
- package/packages/claude/agents/context-builder.md +142 -0
- package/packages/claude/agents/feature-planner.md +199 -0
- package/packages/claude/agents/market-researcher.md +89 -0
- package/packages/claude/agents/orchestrator.md +117 -0
- package/packages/claude/agents/quality-assurance.md +115 -0
- package/packages/claude/agents/system-architect.md +135 -0
- package/packages/claude/agents/ui-designer.md +184 -0
- package/packages/claude/commands/debug.md +20 -0
- package/packages/claude/commands/explain.md +18 -0
- package/packages/claude/commands/git-commit.md +14 -0
- package/packages/claude/commands/optimize.md +20 -0
- package/packages/claude/commands/refactor.md +21 -0
- package/packages/claude/commands/review.md +18 -0
- package/packages/claude/commands/security.md +21 -0
- package/packages/claude/commands/ship.md +18 -0
- package/packages/claude/commands/stash.md +45 -0
- package/packages/claude/commands/test-generate.md +18 -0
- package/packages/claude/skills/brainstorming/SKILL.md +56 -0
- package/packages/claude/skills/code-review/SKILL.md +107 -0
- package/packages/claude/skills/code-review/code-reviewer.md +146 -0
- package/packages/claude/skills/condition-based-waiting/SKILL.md +122 -0
- package/packages/claude/skills/condition-based-waiting/example.ts +158 -0
- package/packages/claude/skills/docs-builder/SKILL.md +106 -0
- package/packages/claude/skills/docs-builder/references/templates.md +572 -0
- package/packages/claude/skills/root-cause-tracing/SKILL.md +176 -0
- package/packages/claude/skills/root-cause-tracing/find-polluter.sh +63 -0
- package/packages/claude/skills/skill-creator/LICENSE.txt +202 -0
- package/packages/claude/skills/skill-creator/SKILL.md +211 -0
- package/packages/claude/skills/skill-creator/scripts/init_skill.py +303 -0
- package/packages/claude/skills/skill-creator/scripts/package_skill.py +110 -0
- package/packages/claude/skills/skill-creator/scripts/quick_validate.py +65 -0
- package/packages/claude/skills/systematic-debugging/CREATION-LOG.md +119 -0
- package/packages/claude/skills/systematic-debugging/SKILL.md +296 -0
- package/packages/claude/skills/systematic-debugging/test-academic.md +14 -0
- package/packages/claude/skills/systematic-debugging/test-pressure-1.md +58 -0
- package/packages/claude/skills/systematic-debugging/test-pressure-2.md +68 -0
- package/packages/claude/skills/systematic-debugging/test-pressure-3.md +69 -0
- package/packages/claude/skills/test-driven-development/SKILL.md +392 -0
- package/packages/claude/skills/testing-anti-patterns/SKILL.md +304 -0
- package/packages/claude/skills/verification-before-completion/SKILL.md +152 -0
- package/packages/claude/variants.json +9 -0
- package/packages/droid/AGENTS.md +52 -0
- package/packages/droid/README.md +17 -0
- package/packages/droid/change_settings.json +61 -0
- package/packages/droid/commands/brainstorming.md +56 -0
- package/packages/droid/commands/code-review.md +107 -0
- package/packages/droid/commands/condition-based-waiting/example.ts +158 -0
- package/packages/droid/commands/condition-based-waiting.md +122 -0
- package/packages/droid/commands/debug.md +20 -0
- package/packages/droid/commands/docs-builder/templates.md +572 -0
- package/packages/droid/commands/docs-builder.md +106 -0
- package/packages/droid/commands/explain.md +18 -0
- package/packages/droid/commands/git-commit.md +14 -0
- package/packages/droid/commands/optimize.md +20 -0
- package/packages/droid/commands/refactor.md +21 -0
- package/packages/droid/commands/review.md +18 -0
- package/packages/droid/commands/root-cause-tracing/find-polluter.sh +63 -0
- package/packages/droid/commands/root-cause-tracing.md +176 -0
- package/packages/droid/commands/security.md +21 -0
- package/packages/droid/commands/ship.md +18 -0
- package/packages/droid/commands/skill-creator/scripts/init_skill.py +303 -0
- package/packages/droid/commands/skill-creator/scripts/package_skill.py +110 -0
- package/packages/droid/commands/skill-creator/scripts/quick_validate.py +65 -0
- package/packages/droid/commands/skill-creator.md +211 -0
- package/packages/droid/commands/stash.md +45 -0
- package/packages/droid/commands/systematic-debugging.md +297 -0
- package/packages/droid/commands/test-driven-development.md +390 -0
- package/packages/droid/commands/test-generate.md +18 -0
- package/packages/droid/commands/testing-anti-patterns.md +304 -0
- package/packages/droid/commands/verification-before-completion.md +152 -0
- package/packages/droid/droids/1-create-prd.md +170 -0
- package/packages/droid/droids/2-generate-tasks.md +190 -0
- package/packages/droid/droids/3-process-task-list.md +225 -0
- package/packages/droid/droids/code-developer.md +198 -0
- package/packages/droid/droids/context-builder.md +142 -0
- package/packages/droid/droids/feature-planner.md +199 -0
- package/packages/droid/droids/market-researcher.md +89 -0
- package/packages/droid/droids/orchestrator.md +116 -0
- package/packages/droid/droids/quality-assurance.md +115 -0
- package/packages/droid/droids/system-architect.md +135 -0
- package/packages/droid/droids/ui-designer.md +184 -0
- package/packages/droid/variants.json +8 -0
- package/packages/opencode/AGENTS.md +52 -0
- package/packages/opencode/README.md +17 -0
- package/packages/opencode/agent/1-create-prd.md +179 -0
- package/packages/opencode/agent/2-generate-tasks.md +194 -0
- package/packages/opencode/agent/3-process-task-list.md +229 -0
- package/packages/opencode/agent/code-developer.md +202 -0
- package/packages/opencode/agent/context-builder.md +146 -0
- package/packages/opencode/agent/feature-planner.md +203 -0
- package/packages/opencode/agent/market-researcher.md +93 -0
- package/packages/opencode/agent/orchestrator.md +120 -0
- package/packages/opencode/agent/quality-assurance.md +119 -0
- package/packages/opencode/agent/system-architect.md +139 -0
- package/packages/opencode/agent/ui-designer.md +188 -0
- package/packages/opencode/command/brainstorming.md +56 -0
- package/packages/opencode/command/code-review.md +107 -0
- package/packages/opencode/command/condition-based-waiting/example.ts +158 -0
- package/packages/opencode/command/condition-based-waiting.md +122 -0
- package/packages/opencode/command/debug.md +20 -0
- package/packages/opencode/command/docs-builder/templates.md +572 -0
- package/packages/opencode/command/docs-builder.md +106 -0
- package/packages/opencode/command/explain.md +18 -0
- package/packages/opencode/command/git-commit.md +14 -0
- package/packages/opencode/command/optimize.md +20 -0
- package/packages/opencode/command/refactor.md +21 -0
- package/packages/opencode/command/review.md +18 -0
- package/packages/opencode/command/root-cause-tracing/find-polluter.sh +63 -0
- package/packages/opencode/command/root-cause-tracing.md +176 -0
- package/packages/opencode/command/security.md +21 -0
- package/packages/opencode/command/ship.md +18 -0
- package/packages/opencode/command/skill-creator/scripts/init_skill.py +303 -0
- package/packages/opencode/command/skill-creator/scripts/package_skill.py +110 -0
- package/packages/opencode/command/skill-creator/scripts/quick_validate.py +65 -0
- package/packages/opencode/command/skill-creator.md +211 -0
- package/packages/opencode/command/stash.md +45 -0
- package/packages/opencode/command/systematic-debugging.md +297 -0
- package/packages/opencode/command/test-driven-development.md +390 -0
- package/packages/opencode/command/test-generate.md +18 -0
- package/packages/opencode/command/testing-anti-patterns.md +304 -0
- package/packages/opencode/command/verification-before-completion.md +152 -0
- package/packages/opencode/opencode.jsonc +201 -0
- package/packages/opencode/variants.json +8 -0
- package/packages/subagentic-manual.md +349 -0
- package/postinstall.js +21 -0
- package/tools/ampcode/manifest-template.json +14 -0
- package/tools/claude/manifest-template.json +14 -0
- package/tools/droid/manifest-template.json +14 -0
- package/tools/opencode/manifest-template.json +14 -0
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
# Quick Start: Publishing with `pass`
|
|
2
|
+
|
|
3
|
+
You're using `pass` to securely store your GitHub token. Here's everything you need!
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## ✅ Your Setup
|
|
8
|
+
|
|
9
|
+
**Token Location in pass:** `amr/github`
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## 🚀 Publishing (3 Simple Ways)
|
|
14
|
+
|
|
15
|
+
### Method 1: Fully Automatic (Easiest) ⭐
|
|
16
|
+
|
|
17
|
+
The `publish.sh` script automatically retrieves your token from `pass`:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
./publish.sh
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
**That's it!** No need to export anything manually.
|
|
24
|
+
|
|
25
|
+
### Method 2: One-Line Publish
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
export GITHUB_TOKEN=$(pass show amr/github) && npm run publish:both
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
### Method 3: Helper Script
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
source ./set-github-token.sh
|
|
35
|
+
npm run publish:both
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## 📋 Common Commands
|
|
41
|
+
|
|
42
|
+
### View your token
|
|
43
|
+
```bash
|
|
44
|
+
pass show amr/github
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Export token for current session
|
|
48
|
+
```bash
|
|
49
|
+
export GITHUB_TOKEN=$(pass show amr/github)
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Verify token is set
|
|
53
|
+
```bash
|
|
54
|
+
echo $GITHUB_TOKEN | cut -c1-10
|
|
55
|
+
# Should show: ghp_...
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Update token in pass
|
|
59
|
+
```bash
|
|
60
|
+
pass edit amr/github
|
|
61
|
+
# Or insert new one
|
|
62
|
+
pass insert -f amr/github
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## 🔄 Complete Release Workflow
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
# 1. Update version
|
|
71
|
+
./UPDATE_VERSION.sh 1.2.0
|
|
72
|
+
|
|
73
|
+
# 2. Update CHANGELOG.md
|
|
74
|
+
# (Edit with your changes)
|
|
75
|
+
|
|
76
|
+
# 3. Commit and tag
|
|
77
|
+
git add .
|
|
78
|
+
git commit -m "Bump version to 1.2.0"
|
|
79
|
+
git tag v1.2.0
|
|
80
|
+
git push origin main --tags
|
|
81
|
+
|
|
82
|
+
# 4. Publish (automatic pass retrieval!)
|
|
83
|
+
./publish.sh
|
|
84
|
+
|
|
85
|
+
# 5. Verify
|
|
86
|
+
# - npm.js: https://www.npmjs.com/package/agentflow
|
|
87
|
+
# - GitHub: https://github.com/amrhas82/agentflow/packages
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## 🔐 Security Tips
|
|
93
|
+
|
|
94
|
+
✅ Your token is encrypted with GPG
|
|
95
|
+
✅ Never stored in plain text
|
|
96
|
+
✅ Not in shell history or config files
|
|
97
|
+
✅ Scripts retrieve it automatically when needed
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## 🆘 Troubleshooting
|
|
102
|
+
|
|
103
|
+
### "pass: command not found"
|
|
104
|
+
```bash
|
|
105
|
+
sudo apt install pass # Ubuntu/Debian
|
|
106
|
+
brew install pass # macOS
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### "amr/github is not in the password store"
|
|
110
|
+
```bash
|
|
111
|
+
pass insert amr/github
|
|
112
|
+
# Enter your token when prompted
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Token not working
|
|
116
|
+
```bash
|
|
117
|
+
# Verify token in pass
|
|
118
|
+
pass show amr/github
|
|
119
|
+
|
|
120
|
+
# Should start with ghp_
|
|
121
|
+
pass show amr/github | head -c 4
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### Need to regenerate token
|
|
125
|
+
1. Go to: https://github.com/settings/tokens
|
|
126
|
+
2. Generate new token (classic)
|
|
127
|
+
3. Scopes: `write:packages`, `read:packages`
|
|
128
|
+
4. Update in pass:
|
|
129
|
+
```bash
|
|
130
|
+
pass insert -f amr/github
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
## 📚 Full Documentation
|
|
136
|
+
|
|
137
|
+
- **Pass Integration Guide:** [docs/PASS_INTEGRATION.md](PASS_INTEGRATION.md)
|
|
138
|
+
- **GitHub Setup:** [docs/GITHUB_SETUP.md](GITHUB_SETUP.md)
|
|
139
|
+
- **Publishing Guide:** [docs/PUBLISHING.md](PUBLISHING.md)
|
|
140
|
+
|
|
141
|
+
---
|
|
142
|
+
|
|
143
|
+
## ⚡ TL;DR
|
|
144
|
+
|
|
145
|
+
**Just run:**
|
|
146
|
+
```bash
|
|
147
|
+
./publish.sh
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
**The script does everything automatically!** 🎉
|
package/docs/PRIVACY.md
ADDED
|
@@ -0,0 +1,203 @@
|
|
|
1
|
+
# Privacy Policy - Agentic Kit Telemetry
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Agentic Kit respects your privacy. This document explains our optional telemetry system and what data we collect (and don't collect) to help improve the software.
|
|
6
|
+
|
|
7
|
+
## Important Principles
|
|
8
|
+
|
|
9
|
+
1. **Opt-In Only**: Telemetry is completely optional. We will never collect data without your explicit consent.
|
|
10
|
+
2. **Anonymous**: All data collected is anonymous and cannot be linked to you personally.
|
|
11
|
+
3. **Transparent**: We clearly document what we collect and don't collect.
|
|
12
|
+
4. **Respectful**: You can change your mind anytime - opt-in or opt-out at will.
|
|
13
|
+
|
|
14
|
+
## Telemetry Consent
|
|
15
|
+
|
|
16
|
+
When you first run the Agentic Kit installer, you'll be asked:
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
Would you like to share anonymous usage statistics to help improve agentflow? (y/N)
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
- **Default is NO**: If you just press Enter, telemetry is disabled
|
|
23
|
+
- **Explicit Consent**: You must type 'y' to enable telemetry
|
|
24
|
+
- **One-Time Prompt**: We only ask once; your choice is saved
|
|
25
|
+
- **Easy to Change**: You can modify your consent anytime
|
|
26
|
+
|
|
27
|
+
## What Data We Collect
|
|
28
|
+
|
|
29
|
+
When you **opt-in**, we collect the following anonymous data:
|
|
30
|
+
|
|
31
|
+
### Installation Events
|
|
32
|
+
- **Package variant selected**: Which variant you chose (lite, standard, or pro)
|
|
33
|
+
- **Tool count**: How many tools you installed (not which specific tools)
|
|
34
|
+
- **Installation time**: How long the installation took (in milliseconds)
|
|
35
|
+
- **Success status**: Whether installation succeeded or failed
|
|
36
|
+
- **Error count**: Number of errors encountered (not the error details)
|
|
37
|
+
- **Warning count**: Number of warnings encountered
|
|
38
|
+
|
|
39
|
+
### System Information
|
|
40
|
+
- **Operating system type**: Platform name (e.g., linux, darwin, win32)
|
|
41
|
+
- **Node.js version**: The version of Node.js you're using
|
|
42
|
+
- **Agentic Kit version**: The version of agentflow you installed
|
|
43
|
+
|
|
44
|
+
### Upgrade Events
|
|
45
|
+
- **From variant**: The variant you upgraded from
|
|
46
|
+
- **To variant**: The variant you upgraded to
|
|
47
|
+
- **Success status**: Whether upgrade succeeded or failed
|
|
48
|
+
|
|
49
|
+
### Uninstallation Events
|
|
50
|
+
- **Success status**: Whether uninstallation succeeded or failed
|
|
51
|
+
|
|
52
|
+
## What Data We DON'T Collect
|
|
53
|
+
|
|
54
|
+
We explicitly **do not** collect:
|
|
55
|
+
|
|
56
|
+
- ❌ **File paths**: No installation directories or file locations
|
|
57
|
+
- ❌ **Personal information**: No usernames, emails, or identifying information
|
|
58
|
+
- ❌ **System details**: No detailed hardware specs, memory usage, or system configuration
|
|
59
|
+
- ❌ **Specific tool names**: We don't track which specific tools you selected
|
|
60
|
+
- ❌ **User-created content**: No code, files, or data you create
|
|
61
|
+
- ❌ **Network information**: No IP addresses or network identifiers
|
|
62
|
+
- ❌ **Installation location**: No absolute or relative paths
|
|
63
|
+
- ❌ **Error messages**: No detailed error text or stack traces
|
|
64
|
+
|
|
65
|
+
## How Data is Stored
|
|
66
|
+
|
|
67
|
+
Currently, telemetry data is stored locally on your machine at:
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+
~/.agentic-kit-telemetry.log
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
In future versions, with your consent, this data may be sent to a secure analytics endpoint to help aggregate usage patterns. Any such change will:
|
|
74
|
+
- Be clearly communicated in release notes
|
|
75
|
+
- Require you to re-confirm your consent
|
|
76
|
+
- Use secure, encrypted transmission (HTTPS)
|
|
77
|
+
- Store data in a privacy-respecting manner
|
|
78
|
+
|
|
79
|
+
## Managing Your Consent
|
|
80
|
+
|
|
81
|
+
### Check Current Status
|
|
82
|
+
|
|
83
|
+
Your telemetry consent is stored in:
|
|
84
|
+
```
|
|
85
|
+
~/.agentic-kit-config.json
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
You can view this file to see your current setting:
|
|
89
|
+
```json
|
|
90
|
+
{
|
|
91
|
+
"telemetry": true,
|
|
92
|
+
"telemetryConsentDate": "2025-01-15T10:30:00Z"
|
|
93
|
+
}
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Disable Telemetry
|
|
97
|
+
|
|
98
|
+
You have several options to disable telemetry:
|
|
99
|
+
|
|
100
|
+
#### Option 1: Edit Config File
|
|
101
|
+
Edit `~/.agentic-kit-config.json` and set:
|
|
102
|
+
```json
|
|
103
|
+
{
|
|
104
|
+
"telemetry": false
|
|
105
|
+
}
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
#### Option 2: Use --no-telemetry Flag
|
|
109
|
+
Run the installer with the flag:
|
|
110
|
+
```bash
|
|
111
|
+
node installer/cli.js --no-telemetry
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
This flag:
|
|
115
|
+
- Disables telemetry for this installation only
|
|
116
|
+
- Doesn't change your saved consent setting
|
|
117
|
+
- Can be used anytime
|
|
118
|
+
|
|
119
|
+
#### Option 3: Delete Config File
|
|
120
|
+
Remove the config file completely:
|
|
121
|
+
```bash
|
|
122
|
+
rm ~/.agentic-kit-config.json
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
You'll be prompted again on next installation.
|
|
126
|
+
|
|
127
|
+
### Enable Telemetry
|
|
128
|
+
|
|
129
|
+
To enable telemetry after previously declining:
|
|
130
|
+
|
|
131
|
+
1. Edit `~/.agentic-kit-config.json` and set `"telemetry": true`
|
|
132
|
+
2. Or delete the config file and run installer again to be re-prompted
|
|
133
|
+
|
|
134
|
+
## View Collected Data
|
|
135
|
+
|
|
136
|
+
All locally collected telemetry is stored in plaintext at:
|
|
137
|
+
```
|
|
138
|
+
~/.agentic-kit-telemetry.log
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
You can view this file anytime to see exactly what data has been collected:
|
|
142
|
+
```bash
|
|
143
|
+
cat ~/.agentic-kit-telemetry.log
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
Each entry is a JSON object on a single line, for example:
|
|
147
|
+
```json
|
|
148
|
+
{"timestamp":"2025-01-15T10:30:00Z","event":"installation","variant":"standard","toolCount":2,"installationTimeMs":45000,"success":true,"errorCount":0,"warningCount":0,"osType":"linux","nodeVersion":"v18.0.0","agenticKitVersion":"1.2.0"}
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
## Delete All Telemetry Data
|
|
152
|
+
|
|
153
|
+
To completely remove all telemetry data from your system:
|
|
154
|
+
|
|
155
|
+
```bash
|
|
156
|
+
rm ~/.agentic-kit-telemetry.log
|
|
157
|
+
rm ~/.agentic-kit-config.json
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
This removes:
|
|
161
|
+
- All collected telemetry data
|
|
162
|
+
- Your consent setting
|
|
163
|
+
- The config file
|
|
164
|
+
|
|
165
|
+
## Why We Collect This Data
|
|
166
|
+
|
|
167
|
+
Anonymous usage statistics help us:
|
|
168
|
+
|
|
169
|
+
1. **Understand Usage Patterns**: Know which variants are most popular
|
|
170
|
+
2. **Improve Installation Experience**: Track installation success rates and times
|
|
171
|
+
3. **Prioritize Development**: Focus on the features users actually use
|
|
172
|
+
4. **Fix Issues**: Identify common installation problems
|
|
173
|
+
5. **Platform Support**: Understand which platforms need better support
|
|
174
|
+
|
|
175
|
+
## Questions or Concerns
|
|
176
|
+
|
|
177
|
+
If you have questions about our privacy policy or data collection:
|
|
178
|
+
|
|
179
|
+
- **GitHub Issues**: https://github.com/amrhas82/agentflow/issues
|
|
180
|
+
- **Review Code**: Our telemetry code is open source in `installer/telemetry.js`
|
|
181
|
+
- **Request Clarification**: Open an issue if anything is unclear
|
|
182
|
+
|
|
183
|
+
## Updates to This Policy
|
|
184
|
+
|
|
185
|
+
We may update this privacy policy as we add features. Any changes will:
|
|
186
|
+
- Be documented in CHANGELOG.md
|
|
187
|
+
- Require re-consent if data collection changes significantly
|
|
188
|
+
- Be clearly communicated in release notes
|
|
189
|
+
|
|
190
|
+
## Summary
|
|
191
|
+
|
|
192
|
+
**TL;DR:**
|
|
193
|
+
- ✅ Telemetry is opt-in only (default: disabled)
|
|
194
|
+
- ✅ Data is completely anonymous
|
|
195
|
+
- ✅ You can opt-out anytime with `--no-telemetry`
|
|
196
|
+
- ✅ All collected data is stored locally and viewable
|
|
197
|
+
- ✅ We never collect personal information or file paths
|
|
198
|
+
- ✅ The code is open source - you can audit it
|
|
199
|
+
|
|
200
|
+
---
|
|
201
|
+
|
|
202
|
+
**Last Updated**: January 2025
|
|
203
|
+
**Version**: 1.0
|