#![cfg_attr(not(test), deny(clippy::unwrap_used, clippy::expect_used, clippy::panic, clippy::unimplemented, clippy::todo, clippy::unreachable))]
mod apphost;
mod extensions;
mod gpu;
mod testing;
use std::net::SocketAddr;
use std::path::PathBuf;
use std::process::ExitCode;
use std::sync::Arc;
use byob_agent::{EngineConfig, EngineHandle};
use byob_store::{Paths, Secrets, Settings, StorageKind, Theme};
use byob_types::InferenceConfig;
#[derive(Default)]
struct Args {
serve: Option<SocketAddr>,
headless: bool,
web_dir: Option<PathBuf>,
allowed_users: Vec<String>,
inference_url: Option<String>,
model: Option<String>,
api_key: Option<String>,
workspace: Option<PathBuf>,
dev_tools: bool,
auto_approve: bool,
plugins: Vec<PathBuf>,
theme: Option<String>,
open_settings: bool,
settings_section: Option<String>,
window_size: Option<[f32; 2]>,
tool_mode: byob_agent::ToolMode,
compact_at: Option<usize>,
storage: Option<StorageKind>,
chats_folder: Option<PathBuf>,
export_to: Option<StorageKind>,
script: testing::Script,
}
fn storage_kind(flag: &str, v: Option<String>) -> Result<StorageKind, String> {
match v.as_deref() {
Some("sqlite") => Ok(StorageKind::Sqlite),
Some("folder") => Ok(StorageKind::Folder),
Some(other) => Err(format!("unknown storage {other:?} for {flag} (sqlite, folder)")),
None => Err(format!("{flag} needs sqlite or folder")),
}
}
fn web_dir(explicit: Option<PathBuf>) -> Option<PathBuf> {
if explicit.is_some() || byob_server::embedded_web_available() {
return explicit;
}
let dev = PathBuf::from("apps/byob-web/dist");
dev.join("index.html").is_file().then_some(dev)
}
fn parse_args() -> Result<Args, String> {
let default_addr = SocketAddr::from(([127, 0, 0, 1], 7470));
let mut args = Args {
serve: None,
headless: false,
allowed_users: Vec::new(),
web_dir: std::env::var_os("BYOB_WEB_DIR").map(PathBuf::from),
inference_url: None,
model: None,
api_key: std::env::var("BYOB_API_KEY").ok().filter(|k| !k.is_empty()),
workspace: None,
dev_tools: false,
auto_approve: false,
plugins: Vec::new(),
theme: None,
open_settings: false,
settings_section: None,
window_size: None,
tool_mode: byob_agent::ToolMode::Auto,
compact_at: None,
storage: None,
chats_folder: None,
export_to: None,
script: testing::Script { after: std::time::Duration::from_secs(2), ..Default::default() },
};
let mut it = std::env::args().skip(1).peekable();
while let Some(arg) = it.next() {
match arg.as_str() {
"--serve" | "--headless" => {
args.headless |= arg == "--headless";
let addr = match it.peek() {
Some(next) if !next.starts_with("--") => {
let v = it.next().unwrap_or_default();
v.parse().map_err(|e| format!("bad address {v:?}: {e}"))?
}
_ => default_addr,
};
args.serve = Some(addr);
}
"--web-dir" => args.web_dir = Some(it.next().ok_or("--web-dir needs a path")?.into()),
"--allow-user" => args.allowed_users.push(it.next().ok_or("--allow-user needs a Tailscale login")?),
"--inference-url" => args.inference_url = Some(it.next().ok_or("--inference-url needs a URL")?),
"--model" => args.model = Some(it.next().ok_or("--model needs a name")?),
"--workspace" => args.workspace = Some(it.next().ok_or("--workspace needs a folder")?.into()),
"--storage" => args.storage = Some(storage_kind("--storage", it.next())?),
"--chats-folder" => args.chats_folder = Some(it.next().ok_or("--chats-folder needs a folder")?.into()),
"--export-chats-to" => args.export_to = Some(storage_kind("--export-chats-to", it.next())?),
"--dev-tools" => args.dev_tools = true,
"--auto-approve" => args.auto_approve = true,
"--plugin" => args.plugins.push(it.next().ok_or("--plugin needs a folder")?.into()),
"--theme" => {
args.theme = Some(it.next().ok_or("--theme needs a name")?);
}
"--open-settings" => args.open_settings = true,
"--settings-section" => args.settings_section = Some(it.next().ok_or("--settings-section needs knobs or advanced")?),
"--window-size" => {
let v = it.next().ok_or("--window-size needs WxH")?;
let size = v.split_once('x').and_then(|(w, h)| Some([w.parse::<f32>().ok()?, h.parse::<f32>().ok()?]));
args.window_size = Some(
size.filter(|[w, h]| (200.0..=8000.0).contains(w) && (200.0..=8000.0).contains(h))
.ok_or_else(|| format!("bad window size {v:?} (e.g. 400x850)"))?,
);
}
"--tool-mode" => {
let v = it.next().ok_or("--tool-mode needs auto, native or prompt")?;
args.tool_mode = byob_agent::ToolMode::parse(&v).ok_or_else(|| format!("unknown tool mode {v:?} (auto, native, prompt)"))?;
}
"--compact-at" => {
let v = it.next().ok_or("--compact-at needs a token count")?;
args.compact_at = Some(v.parse().map_err(|e| format!("bad token count {v:?}: {e}"))?);
}
"--send" => args.script.send.push(it.next().ok_or("--send needs text")?),
"--queue" => args.script.queue.push(it.next().ok_or("--queue needs text")?),
"--stop-after" => {
let v = it.next().ok_or("--stop-after needs seconds")?;
let secs: f64 = v.parse().map_err(|e| format!("bad seconds {v:?}: {e}"))?;
args.script.stop_after = Some(std::time::Duration::try_from_secs_f64(secs).map_err(|e| format!("bad seconds {v:?}: {e}"))?);
}
"--shoot-queued" => args.script.shoot_queued = true,
"--test-connection" => {
let url = it.next().ok_or("--test-connection needs a URL and a model")?;
let model = it.next().ok_or("--test-connection needs a URL and a model")?;
args.script.test_connection = Some((url, model));
}
"--new-workspace" => {
let name = it.next().ok_or("--new-workspace needs a name and auto, host, nix or container")?;
let env = match it.next().as_deref() {
Some("auto") => byob_types::config::EnvKind::Auto,
Some("host") => byob_types::config::EnvKind::Host,
Some("nix") => byob_types::config::EnvKind::Nix,
Some("container") => byob_types::config::EnvKind::Container,
other => return Err(format!("--new-workspace {name}: unknown environment {other:?} (auto, host, nix, container)")),
};
args.script.new_workspace = Some((name, env));
}
"--open-panel" => {
let v = it.next().ok_or("--open-panel needs a name")?;
let plugin_panel = v == "plugin-pane" || v.starts_with("plugin-pane:") || v.starts_with("plugin:") || v.starts_with("artifact:");
if !plugin_panel && !byob_ui_egui::ByobApp::PANELS.split(", ").any(|p| p == v) {
return Err(format!("unknown panel {v:?} ({}, {})", byob_ui_egui::ByobApp::PANELS, byob_ui_egui::ByobApp::PLUGIN_PANELS));
}
args.script.open_panel = Some(v);
}
"--draft" => args.script.draft = Some(it.next().ok_or("--draft needs text")?),
"--attach" => args.script.attach.push(it.next().ok_or("--attach needs a file")?.into()),
"--screenshot" => args.script.screenshot = Some(it.next().ok_or("--screenshot needs a file")?.into()),
"--then" => {
let v = it.next().ok_or("--then needs a command")?;
args.script.then.push(testing::Command::parse(&v).ok_or_else(|| format!("unknown command {v:?} ({})", testing::Command::NAMES))?);
}
"--screenshot-after" => {
let v = it.next().ok_or("--screenshot-after needs seconds")?;
let secs: f64 = v.parse().map_err(|e| format!("bad seconds {v:?}: {e}"))?;
args.script.after = std::time::Duration::try_from_secs_f64(secs).map_err(|e| format!("bad seconds {v:?}: {e}"))?;
}
"-h" | "--help" => {
return Err(
"usage: byob [--serve [ADDR] | --headless [ADDR]] [--web-dir DIR] [--allow-user LOGIN]... [--inference-url URL] [--model NAME] [--workspace DIR] [--storage sqlite|folder] [--chats-folder DIR] [--export-chats-to sqlite|folder] [--plugin DIR]... [--dev-tools] [--theme system|dark|light|THEME]"
.into(),
);
}
other => return Err(format!("unknown argument {other:?} (try --help)")),
}
}
Ok(args)
}
struct App {
ui: byob_ui_egui::ByobApp,
script: testing::Runner,
}
impl eframe::App for App {
fn ui(&mut self, ui: &mut egui::Ui, _frame: &mut eframe::Frame) {
self.ui.ui(ui);
let ctx = ui.ctx().clone();
self.script.frame(&mut self.ui, &ctx);
}
fn save(&mut self, storage: &mut dyn eframe::Storage) {
eframe::set_value(storage, byob_ui_egui::theme::Prefs::STORAGE_KEY, &self.ui.prefs());
eframe::set_value(storage, byob_ui_egui::pane::PanePrefs::STORAGE_KEY, &self.ui.pane_prefs());
}
}
fn main() -> ExitCode {
if let Some(code) = byob_sandbox::dispatch_helper() {
return code;
}
env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init();
match run() {
Ok(()) => ExitCode::SUCCESS,
Err(e) => {
eprintln!("byob: {e}");
ExitCode::FAILURE
}
}
}
struct Saved {
paths: Option<Paths>,
settings: Settings,
secrets: Secrets,
}
fn load_saved() -> Saved {
match Paths::resolve() {
Ok(paths) => {
let settings = Settings::load(&paths.settings()).value;
let secrets = Secrets::load(&paths.secrets()).value;
Saved { paths: Some(paths), settings, secrets }
}
Err(e) => {
log::warn!("{e}; chats and settings won't be saved this run");
Saved { paths: None, settings: Settings::default(), secrets: Secrets::default() }
}
}
}
fn inference_config(args: &Args, settings: &Settings, secrets: &Secrets) -> InferenceConfig {
let defaults = InferenceConfig::default();
let pick = |flag: &Option<String>, saved: &Option<String>, default: String| {
flag.clone().or_else(|| saved.clone().filter(|s| !s.trim().is_empty())).unwrap_or(default)
};
InferenceConfig {
base_url: pick(&args.inference_url, &settings.inference.base_url, defaults.base_url),
model: pick(&args.model, &settings.inference.model, defaults.model),
api_key: args.api_key.clone().or_else(|| secrets.api_key.clone().filter(|k| !k.is_empty())),
}
}
fn model_roles(main: &InferenceConfig, settings: &Settings, secrets: &Secrets) -> std::collections::BTreeMap<String, InferenceConfig> {
settings
.models
.iter()
.filter(|(name, _)| !name.trim().is_empty())
.map(|(name, role)| {
let base_url = role.base_url.clone().filter(|u| !u.trim().is_empty()).unwrap_or_else(|| main.base_url.clone());
let same = base_url.trim_end_matches('/') == main.base_url.trim_end_matches('/');
let api_key = secrets.model_keys.get(name).filter(|k| !k.is_empty()).cloned().or_else(|| main.api_key.clone().filter(|_| same));
let model = role.model.clone().filter(|m| !m.trim().is_empty()).unwrap_or_else(|| main.model.clone());
(name.clone(), InferenceConfig { base_url, model, api_key })
})
.collect()
}
fn workspace(args: &Args, settings: &Settings) -> Result<Option<PathBuf>, String> {
let (dir, from_flag) = match (&args.workspace, &settings.workspace) {
(Some(dir), _) => (dir.clone(), true),
(None, Some(dir)) => (dir.clone(), false),
(None, None) => return Ok(None),
};
if !dir.is_dir() {
if from_flag {
return Err(format!("workspace {} is not a folder", dir.display()));
}
log::warn!("the saved workspace {} is not a folder; using the current directory", dir.display());
return Ok(None);
}
std::fs::canonicalize(&dir).map(Some).map_err(|e| format!("workspace {}: {e}", dir.display()))
}
fn theme_kind(theme: Theme) -> byob_ui_egui::theme::ThemeKind {
use byob_ui_egui::theme::ThemeKind;
match theme {
Theme::System => ThemeKind::System,
Theme::Light => ThemeKind::Light,
Theme::Dark => ThemeKind::Dark,
}
}
fn storage_settings(args: &Args, settings: &Settings) -> Settings {
Settings {
storage: args.storage.unwrap_or(settings.storage),
chats_folder: args.chats_folder.clone().or_else(|| settings.chats_folder.clone()),
..settings.clone()
}
}
fn export_chats(to: StorageKind, paths: Option<&Paths>, settings: &Settings) -> Result<(), String> {
let paths = paths.ok_or("no data directory to export from")?;
if to == settings.storage {
return Err(format!("chats are already stored in {to:?} storage; pass --storage to pick the source"));
}
paths.ensure().map_err(|e| e.to_string())?;
let from = byob_store::open_backend(settings, paths).map_err(|e| format!("opening the chats: {e}"))?;
let mut dest = byob_store::open_backend(&Settings { storage: to, ..settings.clone() }, paths).map_err(|e| format!("opening the destination: {e}"))?;
let report = byob_store::export(&*from, &mut *dest).map_err(|e| format!("exporting: {e}"))?;
eprintln!(
"byob: copied {} chat(s) ({} messages, {} compactions, {} global grants) from {} to {}",
report.chats,
report.messages,
report.compactions,
report.global_grants,
from.path().display(),
dest.path().display()
);
if !report.skipped.is_empty() {
eprintln!("byob: skipped {} chat(s) the destination already had", report.skipped.len());
}
let name = if to == StorageKind::Folder { "folder" } else { "sqlite" };
eprintln!("byob: to use it, set \"storage\": \"{name}\" in {} (or run with --storage {name})", paths.settings().display());
Ok(())
}
fn run() -> Result<(), String> {
let args = parse_args()?;
if std::env::var_os(byob_store::HOME_ENV).is_none() {
byob_store::Paths::migrate_from_yah();
}
let saved = load_saved();
let storage = storage_settings(&args, &saved.settings);
if let Some(to) = args.export_to {
return export_chats(to, saved.paths.as_ref(), &storage);
}
let mut config = EngineConfig::new(inference_config(&args, &saved.settings, &saved.secrets));
config.onboarded = saved.settings.inference.onboarded() || args.inference_url.is_some();
config.paths = saved.paths;
config.storage = storage.storage;
config.chats_folder = storage.chats_folder;
config.adapt.tool_mode = args.tool_mode;
config.defaults = byob_agent::Layer { base_url: None, model: None, ..saved.settings.global_layer() };
config.scoped_keys = saved.secrets.scoped_keys.clone();
config.workspaces_root = saved.settings.workspaces_root();
let c = saved.settings.compaction;
config.compaction =
byob_agent::CompactOptions { auto: true, threshold_percent: c.threshold_percent, at_tokens: args.compact_at, keep_turns: usize::from(c.keep_turns) };
if args.auto_approve {
log::warn!("--auto-approve: every tool call runs without asking");
config.policy = Some(byob_agent::Policy::ALLOW_ALL);
}
if let Some(dir) = workspace(&args, &saved.settings)? {
config.workspace = dir;
config.register_workspace = true;
}
let saved_theme = theme_kind(saved.settings.theme);
let themes_dir = config.paths.as_ref().map(Paths::themes_dir);
let plugins = args.plugins.clone();
let extra = extensions::load(&mut config.tools, &config.artifact_types, plugins);
config.agents = extra.agents;
config.envs = extra.envs;
config.plugins = Some(extra.plugins);
config.models = model_roles(&config.inference, &saved.settings, &saved.secrets);
let sub = saved.settings.subagents;
config.subagents = byob_agent::SubagentOptions {
enabled: true,
max_parallel: sub.max_parallel.map(usize::from),
max_calls: usize::from(sub.max_tool_calls.max(1)),
time_limit: std::time::Duration::from_secs(u64::from(sub.time_limit_minutes.max(1)) * 60),
};
if args.dev_tools {
byob_agent::dev_tools::register(&mut config.tools);
}
log::info!("{} tools available; new chats work in {}", config.tools.len(), config.workspace.display());
let engine = EngineHandle::spawn_with(config).map_err(|e| format!("starting engine: {e}"))?;
run_ui(args, engine, saved_theme, themes_dir)
}
fn link_base(engine: EngineHandle, serving: Option<SocketAddr>) -> byob_ui_egui::artifact::LinkBase {
let started: std::sync::Mutex<Option<SocketAddr>> = std::sync::Mutex::new(serving.map(|mut a| {
if a.ip().is_unspecified() {
a.set_ip(std::net::Ipv4Addr::LOCALHOST.into());
}
a
}));
Box::new(move || {
let mut slot = started.lock().unwrap_or_else(std::sync::PoisonError::into_inner);
let addr = match *slot {
Some(a) => a,
None => {
let config = byob_server::ServerConfig { addr: SocketAddr::from(([127, 0, 0, 1], 0)), artifacts_only: true, ..Default::default() };
let a = byob_server::spawn(engine.clone(), config).map_err(|e| format!("couldn't start the artifact server: {e}"))?;
*slot = Some(a);
a
}
};
Ok(format!("http://{addr}"))
})
}
fn run_ui(args: Args, engine: EngineHandle, saved_theme: byob_ui_egui::theme::ThemeKind, themes_dir: Option<PathBuf>) -> Result<(), String> {
use byob_ui_egui::theme;
let mut serving = None;
if let Some(addr) = args.serve {
let config = byob_server::ServerConfig { addr, web_dir: web_dir(args.web_dir), allowed_users: args.allowed_users, ..Default::default() };
if let Some(warning) = byob_server::webui::UiCheck::of(config.web_dir.as_deref()).warning() {
eprintln!("byob: warning: {warning}");
}
let bound = byob_server::spawn(engine.clone(), config).map_err(|e| format!("binding {addr}: {e}"))?;
eprintln!("byob: browser UI at http://{bound} (expose on your tailnet with: tailscale serve {})", bound.port());
serving = Some(bound);
}
if args.headless {
loop {
std::thread::park();
}
}
let scratch_state = args.script.screenshot.as_ref().map(|_| std::env::temp_dir().join(format!("byob-headless-{}.ron", std::process::id())));
let options = eframe::NativeOptions {
viewport: egui::ViewportBuilder::default().with_inner_size(args.window_size.unwrap_or([1100.0, 750.0])).with_title("byob"),
wgpu_options: gpu::options(),
persistence_path: scratch_state.clone().or_else(|| window_state_in(std::env::var_os(byob_store::HOME_ENV))),
..Default::default()
};
if let Some(name) = &args.theme {
let user = themes_dir.as_deref().map(|d| theme::file::load_dir(d).0).unwrap_or_default();
if !theme::file::select(&mut theme::Prefs::default(), name, &user) {
let ids: Vec<&str> = theme::presets::PRESETS.iter().map(|p| p.id).collect();
return Err(format!("unknown theme {name:?} (system, dark, light, {}, or a file in the themes folder)", ids.join(", ")));
}
}
let script = testing::Runner::new(args.script);
let (theme_arg, open_settings, section) = (args.theme, args.open_settings, args.settings_section);
let result = eframe::run_native(
"byob",
options,
Box::new(move |cc| {
let ctx = cc.egui_ctx.clone();
let conn = engine.connect(Arc::new(move || ctx.request_repaint()));
let mut ui = byob_ui_egui::ByobApp::new(Box::new(conn), "desktop");
ui.set_link_base(link_base(engine.clone(), serving));
if let Some(view) = apphost::ServoView::new(&cc.egui_ctx) {
ui.set_app_view(Box::new(view));
}
if let Some(dir) = themes_dir {
ui.set_themes_dir(dir);
}
let stored: Option<theme::Prefs> = cc.storage.and_then(|s| eframe::get_value(s, theme::Prefs::STORAGE_KEY));
let mut prefs = stored.unwrap_or(theme::Prefs { theme: saved_theme, ..Default::default() });
if let Some(name) = &theme_arg {
theme::file::select(&mut prefs, name, ui.user_themes());
}
ui.set_prefs(prefs);
if let Some(pane) = cc.storage.and_then(|s| eframe::get_value::<byob_ui_egui::pane::PanePrefs>(s, byob_ui_egui::pane::PanePrefs::STORAGE_KEY)) {
ui.artifacts_mut().set_pane_prefs(pane);
}
ui.set_settings_open(open_settings);
if let Some(section) = §ion {
ui.reveal_settings(section);
}
Ok(Box::new(App { ui, script }))
}),
)
.map_err(|e| e.to_string());
if let Some(path) = scratch_state {
let _ = std::fs::remove_file(path);
}
result
}
fn window_state_in(byob_home: Option<std::ffi::OsString>) -> Option<PathBuf> {
byob_home.filter(|h| !h.is_empty()).map(|h| PathBuf::from(h).join("window.ron"))
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn a_byob_home_profile_keeps_its_own_window_state() {
assert_eq!(window_state_in(Some("/tmp/demo/home".into())), Some(PathBuf::from("/tmp/demo/home/window.ron")));
assert_eq!(window_state_in(Some("".into())), None);
assert_eq!(window_state_in(None), None);
}
fn saved(url: Option<&str>, model: Option<&str>, key: Option<&str>) -> (Settings, Secrets) {
let mut settings = Settings::default();
settings.inference.base_url = url.map(Into::into);
settings.inference.model = model.map(Into::into);
let secrets = Secrets { api_key: key.map(Into::into), ..Default::default() };
(settings, secrets)
}
#[test]
fn model_roles_default_to_the_main_endpoint() {
let main = InferenceConfig { base_url: "http://main/v1".into(), model: "big".into(), api_key: Some("sk-main".into()) };
let mut settings = Settings::default();
settings.models.insert("fast".into(), byob_store::ModelRole { model: Some("small".into()), ..Default::default() });
settings.models.insert("remote".into(), byob_store::ModelRole { base_url: Some("http://other/v1".into()), ..Default::default() });
settings.models.insert("keyed".into(), byob_store::ModelRole { base_url: Some("http://third/v1".into()), ..Default::default() });
let secrets = Secrets { model_keys: [("keyed".to_owned(), "sk-third".to_owned())].into(), ..Default::default() };
let roles = model_roles(&main, &settings, &secrets);
assert_eq!(roles["fast"], InferenceConfig { model: "small".into(), ..main.clone() });
assert_eq!(roles["remote"], InferenceConfig { base_url: "http://other/v1".into(), model: "big".into(), api_key: None });
assert_eq!(roles["keyed"].api_key.as_deref(), Some("sk-third"));
}
#[test]
fn flags_beat_saved_settings_which_beat_defaults() {
let (settings, secrets) = saved(Some("http://saved:1/v1"), Some("saved-model"), Some("sk-saved"));
let none = Args::default();
let c = inference_config(&none, &settings, &secrets);
assert_eq!((c.base_url.as_str(), c.model.as_str(), c.api_key.as_deref()), ("http://saved:1/v1", "saved-model", Some("sk-saved")));
let flags = Args { inference_url: Some("http://flag:2/v1".into()), api_key: Some("sk-env".into()), ..Default::default() };
let c = inference_config(&flags, &settings, &secrets);
assert_eq!((c.base_url.as_str(), c.model.as_str(), c.api_key.as_deref()), ("http://flag:2/v1", "saved-model", Some("sk-env")));
let (empty, no_key) = saved(Some(" "), None, Some(""));
let c = inference_config(&none, &empty, &no_key);
assert_eq!(c, InferenceConfig::default());
}
#[test]
fn workspace_flag_beats_settings_and_a_missing_saved_folder_is_ignored() {
let dir = tempfile::tempdir().unwrap();
let other = tempfile::tempdir().unwrap();
let settings = Settings { workspace: Some(dir.path().into()), ..Default::default() };
let real = |p: &std::path::Path| std::fs::canonicalize(p).unwrap();
assert_eq!(workspace(&Args::default(), &settings).unwrap(), Some(real(dir.path())));
let flag = Args { workspace: Some(other.path().into()), ..Default::default() };
assert_eq!(workspace(&flag, &settings).unwrap(), Some(real(other.path())));
let gone = Settings { workspace: Some(dir.path().join("missing")), ..Default::default() };
assert_eq!(workspace(&Args::default(), &gone).unwrap(), None);
let bad_flag = Args { workspace: Some(dir.path().join("missing")), ..Default::default() };
assert!(workspace(&bad_flag, &settings).is_err());
}
}