docs(install): mention FreeBSD support (#1010)
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
This commit is contained in:
@@ -210,7 +210,7 @@ release:
|
|||||||
brew install steveyegge/beads/bd
|
brew install steveyegge/beads/bd
|
||||||
```
|
```
|
||||||
|
|
||||||
**Quick Install (macOS/Linux):**
|
**Quick Install (macOS/Linux/FreeBSD):**
|
||||||
```bash
|
```bash
|
||||||
curl -sSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/install.sh | bash
|
curl -sSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/install.sh | bash
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -57,7 +57,7 @@ Beads supports hierarchical IDs for epics:
|
|||||||
* **Homebrew:** `brew install steveyegge/beads/bd`
|
* **Homebrew:** `brew install steveyegge/beads/bd`
|
||||||
* **Go:** `go install github.com/steveyegge/beads/cmd/bd@latest`
|
* **Go:** `go install github.com/steveyegge/beads/cmd/bd@latest`
|
||||||
|
|
||||||
**Requirements:** Linux (glibc 2.32+), macOS, or Windows.
|
**Requirements:** Linux (glibc 2.32+), FreeBSD, macOS, or Windows.
|
||||||
|
|
||||||
## 🌐 Community Tools
|
## 🌐 Community Tools
|
||||||
|
|
||||||
|
|||||||
@@ -50,7 +50,7 @@ curl -fsSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/insta
|
|||||||
```
|
```
|
||||||
|
|
||||||
The installer will:
|
The installer will:
|
||||||
- Detect your platform (macOS/Linux, amd64/arm64)
|
- Detect your platform (macOS/Linux/FreeBSD, amd64/arm64)
|
||||||
- Install via `go install` if Go is available
|
- Install via `go install` if Go is available
|
||||||
- Fall back to building from source if needed
|
- Fall back to building from source if needed
|
||||||
- Guide you through PATH setup if necessary
|
- Guide you through PATH setup if necessary
|
||||||
@@ -123,6 +123,18 @@ go build -o bd ./cmd/bd
|
|||||||
sudo mv bd /usr/local/bin/
|
sudo mv bd /usr/local/bin/
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### FreeBSD
|
||||||
|
|
||||||
|
**Via Quick Install Script**:
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/install.sh | bash
|
||||||
|
```
|
||||||
|
|
||||||
|
**Via go install**:
|
||||||
|
```bash
|
||||||
|
go install github.com/steveyegge/beads/cmd/bd@latest
|
||||||
|
```
|
||||||
|
|
||||||
### Windows 11
|
### Windows 11
|
||||||
|
|
||||||
Beads now ships with native Windows support—no MSYS or MinGW required.
|
Beads now ships with native Windows support—no MSYS or MinGW required.
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ curl -fsSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/insta
|
|||||||
```
|
```
|
||||||
|
|
||||||
The installer will:
|
The installer will:
|
||||||
- Detect your platform (macOS/Linux, amd64/arm64)
|
- Detect your platform (macOS/Linux/FreeBSD, amd64/arm64)
|
||||||
- Install via `go install` if Go is available
|
- Install via `go install` if Go is available
|
||||||
- Fall back to building from source if needed
|
- Fall back to building from source if needed
|
||||||
- Guide you through PATH setup if necessary
|
- Guide you through PATH setup if necessary
|
||||||
@@ -79,6 +79,18 @@ paru -S beads-git
|
|||||||
go install github.com/steveyegge/beads/cmd/bd@latest
|
go install github.com/steveyegge/beads/cmd/bd@latest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### FreeBSD
|
||||||
|
|
||||||
|
**Via quick install script**:
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/install.sh | bash
|
||||||
|
```
|
||||||
|
|
||||||
|
**Via go install**:
|
||||||
|
```bash
|
||||||
|
go install github.com/steveyegge/beads/cmd/bd@latest
|
||||||
|
```
|
||||||
|
|
||||||
### Windows 11
|
### Windows 11
|
||||||
|
|
||||||
Beads ships with native Windows support—no MSYS or MinGW required.
|
Beads ships with native Windows support—no MSYS or MinGW required.
|
||||||
|
|||||||
@@ -26,6 +26,9 @@ Traditional issue trackers (Jira, GitHub Issues) weren't designed for AI agents.
|
|||||||
brew tap steveyegge/beads
|
brew tap steveyegge/beads
|
||||||
brew install bd
|
brew install bd
|
||||||
|
|
||||||
|
# Or quick install (macOS/Linux/FreeBSD)
|
||||||
|
curl -fsSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/install.sh | bash
|
||||||
|
|
||||||
# Initialize in your project
|
# Initialize in your project
|
||||||
cd your-project
|
cd your-project
|
||||||
bd init --quiet
|
bd init --quiet
|
||||||
|
|||||||
@@ -30,6 +30,9 @@ Traditional issue trackers (Jira, GitHub Issues) weren't designed for AI agents.
|
|||||||
brew tap steveyegge/beads
|
brew tap steveyegge/beads
|
||||||
brew install bd
|
brew install bd
|
||||||
|
|
||||||
|
# Or quick install (macOS/Linux/FreeBSD)
|
||||||
|
curl -fsSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/install.sh | bash
|
||||||
|
|
||||||
# Initialize in your project
|
# Initialize in your project
|
||||||
cd your-project
|
cd your-project
|
||||||
bd init --quiet
|
bd init --quiet
|
||||||
@@ -277,7 +280,7 @@ curl -fsSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/insta
|
|||||||
```
|
```
|
||||||
|
|
||||||
The installer will:
|
The installer will:
|
||||||
- Detect your platform (macOS/Linux, amd64/arm64)
|
- Detect your platform (macOS/Linux/FreeBSD, amd64/arm64)
|
||||||
- Install via `go install` if Go is available
|
- Install via `go install` if Go is available
|
||||||
- Fall back to building from source if needed
|
- Fall back to building from source if needed
|
||||||
- Guide you through PATH setup if necessary
|
- Guide you through PATH setup if necessary
|
||||||
@@ -326,6 +329,18 @@ paru -S beads-git
|
|||||||
go install github.com/steveyegge/beads/cmd/bd@latest
|
go install github.com/steveyegge/beads/cmd/bd@latest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### FreeBSD
|
||||||
|
|
||||||
|
**Via quick install script**:
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/install.sh | bash
|
||||||
|
```
|
||||||
|
|
||||||
|
**Via go install**:
|
||||||
|
```bash
|
||||||
|
go install github.com/steveyegge/beads/cmd/bd@latest
|
||||||
|
```
|
||||||
|
|
||||||
### Windows 11
|
### Windows 11
|
||||||
|
|
||||||
Beads ships with native Windows support—no MSYS or MinGW required.
|
Beads ships with native Windows support—no MSYS or MinGW required.
|
||||||
@@ -2417,6 +2432,9 @@ bd create <title> [flags]
|
|||||||
--type, -t Issue type (bug|feature|task|epic|chore)
|
--type, -t Issue type (bug|feature|task|epic|chore)
|
||||||
--priority, -p Priority 0-4
|
--priority, -p Priority 0-4
|
||||||
--description, -d Detailed description
|
--description, -d Detailed description
|
||||||
|
--design Design notes
|
||||||
|
--acceptance Acceptance criteria
|
||||||
|
--notes Additional notes
|
||||||
--labels, -l Comma-separated labels
|
--labels, -l Comma-separated labels
|
||||||
--parent Parent issue ID
|
--parent Parent issue ID
|
||||||
--deps Dependencies (type:id format)
|
--deps Dependencies (type:id format)
|
||||||
@@ -2433,6 +2451,13 @@ bd create "Login fails with special chars" -t bug -p 1
|
|||||||
bd create "Add export to PDF" -t feature -p 2 \
|
bd create "Add export to PDF" -t feature -p 2 \
|
||||||
--description="Users want to export reports as PDF files"
|
--description="Users want to export reports as PDF files"
|
||||||
|
|
||||||
|
# Feature with design, acceptance, and notes
|
||||||
|
bd create "Implement user authentication" -t feature -p 1 \
|
||||||
|
--description="Add JWT-based authentication" \
|
||||||
|
--design="Use bcrypt for password hashing, JWT for sessions" \
|
||||||
|
--acceptance="All tests pass, security audit complete" \
|
||||||
|
--notes="Consider rate limiting for login attempts"
|
||||||
|
|
||||||
# Task with labels
|
# Task with labels
|
||||||
bd create "Update CI config" -t task -l "ci,infrastructure"
|
bd create "Update CI config" -t task -l "ci,infrastructure"
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user