@byfriends/cli 0.1.0

package/LICENSE

@@ -0,0 +1,28 @@
+BYF PROPRIETARY LICENSE
+
+Copyright (c) 2026-2027 ByronFinn
+
+Permission is hereby granted to copy and redistribute this software in its
+unmodified form, without charge. This permission does not extend to modified
+versions of the software.
+
+Local modification of this software for personal use is permitted, provided
+that such modifications are not distributed to third parties.
+
+Restrictions:
+1. You may NOT redistribute modified versions of this software.
+2. You may NOT use this software for commercial purposes.
+3. You may NOT sublicense, sell, or offer this software as a service.
+
+This software is source-available but NOT open source. The source code is
+made publicly visible for review purposes only.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+For questions about licensing, contact: https://github.com/ByronFinn/byf/issues

package/README.md

@@ -0,0 +1,72 @@
+# @byfriends/cli
+
+> BYF (Be Your Friend) — an AI coding agent that runs in your terminal
+
+[![npm](https://img.shields.io/npm/v/@byfriends/cli)](https://www.npmjs.com/package/@byfriends/cli) [![License](https://img.shields.io/badge/license-proprietary-blue)](LICENSE)
+
+## Install
+
+### npm (recommended)
+
+```sh
+npm install -g @byfriends/cli
+```
+
+Or with pnpm:
+
+```sh
+pnpm add -g @byfriends/cli
+```
+
+### Quick install (macOS/Linux)
+
+```sh
+curl -fsSL https://github.com/ByronFinn/byf/releases/latest/download/install.sh | bash
+```
+
+### Quick install (Windows)
+
+```powershell
+irm https://github.com/ByronFinn/byf/releases/latest/download/install.ps1 | iex
+```
+
+## Quick Start
+
+Open a project and start the interactive UI:
+
+```sh
+cd your-project
+byf
+```
+
+You can also start with an inline prompt:
+
+```sh
+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`, and `plan` subagents 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](https://github.com/ByronFinn/byf/blob/main/LICENSE) for terms.