Quick Start¶
Get Seev running and generate your first worklog in ≤ 10 minutes.
Tip: Commands first, then explanations. Copy buttons are enabled on this site.
1) Prerequisites¶
- Python 3.13+
- uv (recommended package runner)
- git
Verify:
python -V
uv --version
git --version
2) Initialize your workspace (1–2 minutes)¶
Recommended: use the install script. It prepares a workspace folder, a WORKLOG.md, a local DB, and your Seev config file.
# Create ~/seev-workspace with sensible defaults
/bin/bash -c "$(curl -fsSL https://bcosynot.github.io/seev/init.sh)"
- Creates the target dir if missing
- Writes WORKLOG.md and a local SQLite DB
- Creates/updates ~/.config/seev/seev.toml with placeholders
Security
Always inspect scripts before piping to bash:
curl -fsSL https://raw.githubusercontent.com/bcosynot/seev/main/seev-init.sh -o /tmp/seev-init.sh
less /tmp/seev-init.sh
bash /tmp/seev-init.sh -h
Optional flags:
# Set emails and repos at init time
bash /tmp/seev-init.sh -y \
-e "[email protected],[email protected]" \
-r "org/repo,~/code/another-repo" \
-m WORKLOG.md -d seev.sqlite3 \
~/seev-workspace
3) Add Seev to your MCP client (2–4 minutes)¶
Use one of the tabs below and restart your client after editing its config.
Config file paths:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"seev": {
"command": "uvx",
"args": ["--from", "git+https://github.com/bcosynot/seev.git", "seev"]
}
}
}
Config file path:
- macOS/Linux: ~/.cursor/mcp.json
- Windows: %USERPROFILE%\.cursor\mcp.json
{
"mcpServers": {
"seev": {
"command": "uvx",
"args": ["--from", "git+https://github.com/bcosynot/seev.git", "seev"]
}
}
}
VS Code settings JSON (user or workspace):
{
"cline.mcpServers": {
"seev": {
"command": "uvx",
"args": ["--from", "git+https://github.com/bcosynot/seev.git", "seev"]
}
}
}
4) Generate your first worklog entry (1–3 minutes)¶
Open your assistant and run one of these:
/worklog_entry today
Or a specific date or range:
/worklog_entry 2025-10-20
/worklog_entry last week
What happens:
- Seev gathers your commits, correlates with conversations/PRs, and writes to WORKLOG.md under ## YYYY-MM-DD.
5) Verification checklist¶
- [ ]
WORKLOG.mdexists in your workspace and contains today’s date heading (YYYY-MM-DD). - [ ] Entry includes commits and a metrics section.
- [ ] No client errors after restart; the Seev MCP server shows in logs.
If anything fails, see: Troubleshooting or Workspace & Configuration.