87ed7c8793
Major improvements to code quality, documentation, and CI: Code Quality: - Add golangci-lint configuration with 13 linters - Fix unchecked error returns in export/import/init - Refactor duplicate scanIssues code - Add package comments for all packages - Add const block comments for exported constants - Configure errcheck to allow idiomatic defer patterns Documentation: - Add comprehensive CONTRIBUTING.md with setup, testing, and workflow - Fix QUICKSTART.md binary name references (beads → bd) - Correct default database path documentation CI/CD: - Add GitHub Actions workflow for tests and linting - Enable race detection and coverage reporting - Automated quality checks on all PRs All tests passing. Lint issues reduced from 117 to 103 (remaining are idiomatic patterns and test code). Ready for open-source release. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1.6 KiB
1.6 KiB
Beads Quickstart
Get up and running with Beads in 2 minutes.
Installation
cd ~/src/beads
go build -o bd ./cmd/bd
./bd --help
Your First Issues
# Create a few issues
./bd create "Set up database" -p 1 -t task
./bd create "Create API" -p 2 -t feature
./bd create "Add authentication" -p 2 -t feature
# List them
./bd list
Add Dependencies
# API depends on database
./bd dep add bd-2 bd-1
# Auth depends on API
./bd dep add bd-3 bd-2
# View the tree
./bd dep tree bd-3
Output:
🌲 Dependency tree for bd-3:
→ bd-3: Add authentication [P2] (open)
→ bd-2: Create API [P2] (open)
→ bd-1: Set up database [P1] (open)
Find Ready Work
./bd ready
Output:
📋 Ready work (1 issues with no blockers):
1. [P1] bd-1: Set up database
Only bd-1 is ready because bd-2 and bd-3 are blocked!
Work the Queue
# Start working on bd-1
./bd update bd-1 --status in_progress
# Complete it
./bd close bd-1 --reason "Database setup complete"
# Check ready work again
./bd ready
Now bd-2 is ready! 🎉
Track Progress
# See blocked issues
./bd blocked
# View statistics
./bd stats
Database Location
By default: ~/.beads/default.db
You can use project-specific databases:
./bd --db ./my-project.db create "Task"
Next Steps
- Add labels:
./bd create "Task" -l "backend,urgent" - Filter ready work:
./bd ready --priority 1 - Search issues:
./bd list --status open - Detect cycles:
./bd dep cycles
See README.md for full documentation.