@dev_desh/flux-cap 0.1.0 β 0.1.2
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/README.md +19 -33
- package/dist/index.js +44 -1
- package/package.json +5 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# flux-cap
|
|
2
2
|
|
|
3
3
|
**A git-aware CLI context manager for ADHD developers**
|
|
4
4
|
|
|
@@ -6,33 +6,33 @@
|
|
|
6
6
|
|
|
7
7
|
flux-cap is a terminal-native tool that captures your thoughts, tracks your context, and integrates seamlessly with your git workflow. Built specifically for developers who context-switch frequently.
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Features
|
|
10
10
|
|
|
11
|
-
###
|
|
11
|
+
### Brain Dump System
|
|
12
12
|
- Instantly capture thoughts without breaking flow: `flux dump "fix auth validation bug"`
|
|
13
13
|
- Git-aware context tracking (branch, working directory, uncommitted changes)
|
|
14
14
|
- Monthly file organization for easy browsing
|
|
15
15
|
- Privacy-first design - you control what gets tracked
|
|
16
16
|
|
|
17
|
-
###
|
|
17
|
+
### Search
|
|
18
18
|
- Fuzzy search across all your brain dumps: `flux search "auth"`
|
|
19
19
|
- Configurable search fields (message, branch, working directory)
|
|
20
|
-
-
|
|
20
|
+
- Result ranking with relevance scores
|
|
21
21
|
- Multi-month search with automatic limits
|
|
22
22
|
|
|
23
|
-
###
|
|
23
|
+
### Privacy Controls
|
|
24
24
|
- Choose what information to track during setup
|
|
25
25
|
- Hide working directory paths, branch names, or git status
|
|
26
26
|
- All data stored locally in human-readable JSON
|
|
27
27
|
- Edit or delete your data anytime
|
|
28
28
|
|
|
29
|
-
###
|
|
29
|
+
### Git Integration
|
|
30
30
|
- Automatic branch context detection
|
|
31
31
|
- Uncommitted changes tracking
|
|
32
|
-
-
|
|
32
|
+
- .gitignore management
|
|
33
33
|
- Works in non-git directories too
|
|
34
34
|
|
|
35
|
-
##
|
|
35
|
+
## Installation
|
|
36
36
|
|
|
37
37
|
```bash
|
|
38
38
|
# Clone the repository
|
|
@@ -46,7 +46,7 @@ bun install
|
|
|
46
46
|
bun run dev <command>
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
-
##
|
|
49
|
+
## Quick Start
|
|
50
50
|
|
|
51
51
|
### 1. Initialize flux-cap in your project
|
|
52
52
|
```bash
|
|
@@ -70,7 +70,7 @@ bun run dev search "auth"
|
|
|
70
70
|
bun run dev search
|
|
71
71
|
```
|
|
72
72
|
|
|
73
|
-
##
|
|
73
|
+
## Commands
|
|
74
74
|
|
|
75
75
|
| Command | Description | Example |
|
|
76
76
|
|---------|-------------|---------|
|
|
@@ -80,7 +80,7 @@ bun run dev search
|
|
|
80
80
|
| `flux config <fields...>` | View or update configuration | `bun run dev config` |
|
|
81
81
|
| `flux reset` | Complete reset (deletes all data) | `bun run dev reset` |
|
|
82
82
|
|
|
83
|
-
##
|
|
83
|
+
## Configuration
|
|
84
84
|
|
|
85
85
|
flux-cap stores configuration in `.flux/config.json`. You can customize:
|
|
86
86
|
|
|
@@ -119,7 +119,7 @@ flux-cap stores configuration in `.flux/config.json`. You can customize:
|
|
|
119
119
|
}
|
|
120
120
|
```
|
|
121
121
|
|
|
122
|
-
##
|
|
122
|
+
## Data Structure
|
|
123
123
|
|
|
124
124
|
```
|
|
125
125
|
.flux/
|
|
@@ -142,7 +142,7 @@ flux-cap stores configuration in `.flux/config.json`. You can customize:
|
|
|
142
142
|
}
|
|
143
143
|
```
|
|
144
144
|
|
|
145
|
-
##
|
|
145
|
+
## Use Cases
|
|
146
146
|
|
|
147
147
|
### Context Switching
|
|
148
148
|
```bash
|
|
@@ -168,7 +168,7 @@ flux dump "idea: add keyboard shortcuts to dashboard"
|
|
|
168
168
|
flux dump "maybe use React.memo for performance optimization"
|
|
169
169
|
```
|
|
170
170
|
|
|
171
|
-
##
|
|
171
|
+
## Development
|
|
172
172
|
|
|
173
173
|
Built with:
|
|
174
174
|
- **Bun** - Fast JavaScript runtime
|
|
@@ -190,7 +190,7 @@ src/
|
|
|
190
190
|
βββ types/ # TypeScript definitions
|
|
191
191
|
```
|
|
192
192
|
|
|
193
|
-
##
|
|
193
|
+
## Roadmap
|
|
194
194
|
|
|
195
195
|
### Phase 2 (Coming Soon)
|
|
196
196
|
- [ ] ASCII Pomodoro timer with themes
|
|
@@ -207,28 +207,14 @@ src/
|
|
|
207
207
|
- [ ] Team collaboration features
|
|
208
208
|
- [ ] Cross-machine sync
|
|
209
209
|
|
|
210
|
-
##
|
|
210
|
+
## Contributing
|
|
211
211
|
|
|
212
212
|
This is currently a personal learning project, but feedback and suggestions are welcome!
|
|
213
213
|
|
|
214
|
-
##
|
|
214
|
+
## License
|
|
215
215
|
|
|
216
216
|
MIT
|
|
217
217
|
|
|
218
218
|
---
|
|
219
219
|
|
|
220
|
-
|
|
221
|
-
```
|
|
222
|
-
|
|
223
|
-
This README showcases:
|
|
224
|
-
- β
Clear value proposition for ADHD developers
|
|
225
|
-
- β
All implemented features with examples
|
|
226
|
-
- β
Complete command reference
|
|
227
|
-
- β
Configuration documentation
|
|
228
|
-
- β
Privacy-first messaging
|
|
229
|
-
- β
Data structure transparency
|
|
230
|
-
- β
Real use cases
|
|
231
|
-
- β
Development info
|
|
232
|
-
- β
Future roadmap
|
|
233
|
-
|
|
234
|
-
**Ready to ship this for UAT?** The README positions flux-cap as a professional, thoughtful developer tool.
|
|
220
|
+
Built for developers who think fast, context-switch often, and never want to lose a good idea.
|
package/dist/index.js
CHANGED
|
@@ -25148,10 +25148,53 @@ async function configCommand(fields) {
|
|
|
25148
25148
|
return;
|
|
25149
25149
|
}
|
|
25150
25150
|
}
|
|
25151
|
+
// package.json
|
|
25152
|
+
var package_default = {
|
|
25153
|
+
name: "@dev_desh/flux-cap",
|
|
25154
|
+
version: "0.1.2",
|
|
25155
|
+
description: "Git-aware CLI context manager for ADHD developers",
|
|
25156
|
+
bin: {
|
|
25157
|
+
flux: "./dist/index.js"
|
|
25158
|
+
},
|
|
25159
|
+
files: [
|
|
25160
|
+
"dist/**/*",
|
|
25161
|
+
"README.md",
|
|
25162
|
+
"LICENSE"
|
|
25163
|
+
],
|
|
25164
|
+
scripts: {
|
|
25165
|
+
build: "bun build src/index.ts --outdir dist --target node --format esm",
|
|
25166
|
+
dev: "bun run src/index.ts",
|
|
25167
|
+
prepublishOnly: "bun run build",
|
|
25168
|
+
"local-install": "bun run build && npm link",
|
|
25169
|
+
"local-uninstall": "npm unlink -g flux-cap"
|
|
25170
|
+
},
|
|
25171
|
+
engines: {
|
|
25172
|
+
node: ">=18.0.0"
|
|
25173
|
+
},
|
|
25174
|
+
keywords: [
|
|
25175
|
+
"cli",
|
|
25176
|
+
"productivity",
|
|
25177
|
+
"adhd",
|
|
25178
|
+
"git",
|
|
25179
|
+
"context-switching",
|
|
25180
|
+
"brain-dump",
|
|
25181
|
+
"developer-tools"
|
|
25182
|
+
],
|
|
25183
|
+
dependencies: {
|
|
25184
|
+
inquirer: "^13.2.5"
|
|
25185
|
+
},
|
|
25186
|
+
devDependencies: {
|
|
25187
|
+
"@types/inquirer": "^9.0.9"
|
|
25188
|
+
},
|
|
25189
|
+
repository: {
|
|
25190
|
+
type: "git",
|
|
25191
|
+
url: "https://github.com/kaustubh285/flux-cap"
|
|
25192
|
+
}
|
|
25193
|
+
};
|
|
25151
25194
|
|
|
25152
25195
|
// src/index.ts
|
|
25153
25196
|
var program2 = new Command;
|
|
25154
|
-
program2.name(`flux`).description("Git-aware CLI context manager for ADHD developers").version(
|
|
25197
|
+
program2.name(`flux`).description("Git-aware CLI context manager for ADHD developers").version(package_default.version);
|
|
25155
25198
|
program2.command("init").description("Initialize flux in the current repository").action(initFluxCommand);
|
|
25156
25199
|
program2.command("reset").description("Resets flux in the current repository").action(resetFluxCommand);
|
|
25157
25200
|
program2.command("dump <message...>").description("Add a brain dump with a message. You can also include tags by using #tag in the message.").action(brainDumpAddCommand);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dev_desh/flux-cap",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "Git-aware CLI context manager for ADHD developers",
|
|
5
5
|
"bin": {
|
|
6
6
|
"flux": "./dist/index.js"
|
|
@@ -34,5 +34,9 @@
|
|
|
34
34
|
},
|
|
35
35
|
"devDependencies": {
|
|
36
36
|
"@types/inquirer": "^9.0.9"
|
|
37
|
+
},
|
|
38
|
+
"repository": {
|
|
39
|
+
"type": "git",
|
|
40
|
+
"url": "https://github.com/kaustubh285/flux-cap"
|
|
37
41
|
}
|
|
38
42
|
}
|