Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,4 @@ report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
.DS_Store
context.md
.flux/
docs/
50 changes: 33 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@

**A git-aware CLI context manager for ADHD developers**

> *Never lose track of what you were coding after interruptions again.*
> *Never lose track of what you were coding after interruptions again. Now with intelligent, context-aware search.*


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.

### Recent Releases:
- **v0.8.0:** Search 2.0 - Intelligent multi-signal ranking with context awareness
- **v0.7.0:** Batch searches with combinedQuery and result sorting


## Installation

Install flux-cap globally using your preferred package manager:
Expand Down Expand Up @@ -41,20 +47,25 @@ flux dump -n "team meeting at 3pm tomorrow" # Notes
flux dump -t "refactor payment processing logic" # Tasks
```

### 3. Search your brain dumps
### 3. Search your brain dumps with intelligent ranking

![https://github.com/kaustubh285/flux-cap/blob/main/images/v0.6-search-output.png](https://github.com/kaustubh285/flux-cap/blob/main/images/v0.6-search-output.png)
flux-cap now features **Search 2.0** - intelligent, context-aware search that prioritizes:
- 🔥 **Recent dumps** (exponential decay scoring)
- ⭐ **Same git branch** as your current work
- 📁 **Same working directory** context
- 🏷️ **Exact tag matches** (coming in v0.8.0)

![Search 2.0 Demo - Context-aware ranking](https://github.com/kaustubh285/flux-cap/blob/main/images/v0.8-search-v2-demo.png)

```bash
# Search with a query
flux search auth
# Smart context-aware search (NEW in v0.8.0!)
flux search auth # Prioritizes recent + current branch matches

# Search by tags (when implemented in search)
flux search ideas
flux search tasks
# Coming in v0.8.2: Convenience commands
flux recent # Last 10 dumps
flux here # Current branch + directory
flux notes # All note-tagged dumps

# List recent dumps (no query)
flux search
```

## Features
Expand All @@ -66,12 +77,13 @@ flux search
- Monthly file organization for easy browsing
- Privacy-first design - you control what gets tracked

### Intelligent Search
- Fuzzy search across all your brain dumps: `flux search "auth"`
- **Tag-aware searching** for filtering by type
- Configurable search fields (message, branch, working directory, tags)
- Result ranking with relevance scores
- Multi-month search with automatic limits
### Intelligent Search 2.0 🚀
- **Multi-signal ranking**: Combines fuzzy matching, recency, and git context
- **Smart defaults**: Recent dumps + current branch automatically ranked higher
- **Context-aware**: Prioritizes dumps from your current branch and directory
- **Debug mode**: `--debug` flag shows detailed scoring breakdown
- **Flexible filtering**: `--all`, `--since`, `--branch` flags override smart defaults
- **Fast & local**: No external APIs, blazing fast search results

### Privacy Controls
- Choose what information to track during setup
Expand Down Expand Up @@ -132,6 +144,7 @@ flux dump --tag bug "found an issue"
flux dump --tag meeting "standup notes"
```


### Tag Examples
```bash
# Ideas for future features
Expand Down Expand Up @@ -329,7 +342,10 @@ src/

## Roadmap

### Phase 2 (Coming Soon)
### Phase 2 (v0.8.0 - Coming Soon)
- [ ] Convenience search commands (`flux recent`, `flux here`, `flux notes`)
- [ ] Tag match scoring integration
- [ ] Grouped result display by relevance
- [ ] Enhanced tag-based search filtering
- [ ] ASCII Pomodoro timer with themes
- [ ] Visual focus mode display
Expand Down
5 changes: 4 additions & 1 deletion biome.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@
},
"javascript": {
"formatter": {
"quoteStyle": "double"
"quoteStyle": "double",
"indentStyle": "tab",
"indentWidth": 4,
"trailingNewline": true
}
},
"assist": {
Expand Down
9 changes: 7 additions & 2 deletions bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file added images/v0.8-search-v2-demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading