@byfriends/cli
v0.3.2
Published
BYF (Be Your Friend), an AI coding agent that runs in your terminal
Maintainers
Readme
@byfriends/cli
BYF (Be Your Friend) — an AI coding agent that runs in your terminal
Install
npm (recommended)
npm install -g @byfriends/cliOr with pnpm:
pnpm add -g @byfriends/cliQuick install (macOS/Linux)
curl -fsSL https://github.com/ByronFinn/byf/releases/latest/download/install.sh | bashQuick install (Windows)
irm https://github.com/ByronFinn/byf/releases/latest/download/install.ps1 | iexQuick Start
Open a project and start the interactive UI:
cd your-project
byfYou can also start with an inline prompt:
byf "Explain the main directories in this repository"Configure your provider credentials or API key in ~/.byf/config.toml, then start a session.
Key Features
- Single-binary distribution. Install with one command — no Node.js setup, no PATH gymnastics, no global module conflicts.
- Blazing-fast startup. The TUI is ready in milliseconds, so opening a session never feels heavy.
- Polished TUI. A carefully tuned interface designed for long, focused agent sessions.
- Video input. Drop a screen recording or demo clip into the chat — let the agent watch instead of typing out what's hard to describe in words.
- AI-native MCP configuration. Add, edit, and authenticate Model Context Protocol servers conversationally via
/mcp-config— no hand-editing JSON. - Subagents for focused, parallel work. Dispatch built-in
coder,explore, andplansubagents in isolated context windows; the main conversation stays clean. - Lifecycle hooks. Run local commands at key points — gate risky tool calls, audit decisions, fire desktop notifications, wire into your own automation.
Documentation
See the main repository README for documentation.
Repository & Issues
- Source: https://github.com/ByronFinn/byf
- Issues: https://github.com/ByronFinn/byf/issues
- Security: see SECURITY.md in the main repository
License
Proprietary — see LICENSE for terms.
