From 94b8fa1dce36477e7b8177ce32efcf4377eed0d1 Mon Sep 17 00:00:00 2001 From: Daniel Date: Sun, 13 Sep 2026 15:25:02 +0800 Subject: [PATCH] P0: GrokBoy streaming chat CLI Minimal workspace with OpenAI-compatible streaming chat. No tools yet (P1). --- .gitignore | 5 + Cargo.toml | 18 +++ LICENSE | 202 ++++++++++++++++++++++++++++++ README.md | 49 ++++++++ crates/grokboy-core/Cargo.toml | 15 +++ crates/grokboy-core/src/config.rs | 47 +++++++ crates/grokboy-core/src/lib.rs | 7 ++ crates/grokboy-core/src/model.rs | 155 +++++++++++++++++++++++ crates/grokboy/Cargo.toml | 15 +++ crates/grokboy/src/main.rs | 90 +++++++++++++ docs/ACCEPTANCE.md | 22 ++++ 11 files changed, 625 insertions(+) create mode 100644 .gitignore create mode 100644 Cargo.toml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 crates/grokboy-core/Cargo.toml create mode 100644 crates/grokboy-core/src/config.rs create mode 100644 crates/grokboy-core/src/lib.rs create mode 100644 crates/grokboy-core/src/model.rs create mode 100644 crates/grokboy/Cargo.toml create mode 100644 crates/grokboy/src/main.rs create mode 100644 docs/ACCEPTANCE.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4027b13 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +/target +**/*.rs.bk +.DS_Store +.env +*.swp diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..134315d --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,18 @@ +[workspace] +resolver = "2" +members = ["crates/grokboy-core", "crates/grokboy"] + +[workspace.package] +version = "0.1.0" +edition = "2021" +license = "Apache-2.0" +authors = ["Daniel Wang"] + +[workspace.dependencies] +anyhow = "1" +futures-util = "0.3" +reqwest = { version = "0.12", default-features = false, features = ["json", "rustls-tls", "stream"] } +serde = { version = "1", features = ["derive"] } +serde_json = "1" +tokio = { version = "1", features = ["rt-multi-thread", "macros", "io-std", "io-util", "sync"] } +thiserror = "2" diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..94118ab --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# GrokBoy + +Minimal local **GrokBot-like** CLI agent. Phase **P0**: streaming chat only. + +## Status + +| Phase | Status | +|-------|--------| +| P0 streaming chat | done | +| P1 shell / files + ReAct | next | +| P2 completion / loop guard | planned | +| P3 browser (Playwright) | later | + +No Docker desktop, no Codex/LazyBoy fork. + +## Setup (macOS) + +```bash +export GROKBOY_API_KEY=your_key # or XAI_API_KEY +# optional: +# export GROKBOY_BASE_URL=https://api.x.ai/v1 +# export GROKBOY_MODEL=grok-4 + +cd ~/GrokBoy +cargo run -p grokboy -- chat +``` + +## Commands + +- `grokboy chat` — interactive streaming chat +- `grokboy help` + +## 繁體中文 + +本機終端機聊天 bot。P0 只能對話；P1 才會加讀寫檔與 shell。 + +```bash +export GROKBOY_API_KEY=你的金鑰 +cd ~/GrokBoy +cargo run -p grokboy -- chat +``` + +## Layout + +``` +crates/grokboy-core/ # config + streaming client +crates/grokboy/ # CLI binary +docs/ACCEPTANCE.md +``` diff --git a/crates/grokboy-core/Cargo.toml b/crates/grokboy-core/Cargo.toml new file mode 100644 index 0000000..73064ad --- /dev/null +++ b/crates/grokboy-core/Cargo.toml @@ -0,0 +1,15 @@ +[package] +name = "grokboy-core" +version.workspace = true +edition.workspace = true +license.workspace = true +description = "Minimal GrokBot-like agent core (chat loop)" + +[dependencies] +anyhow.workspace = true +futures-util.workspace = true +reqwest.workspace = true +serde.workspace = true +serde_json.workspace = true +thiserror.workspace = true +tokio.workspace = true diff --git a/crates/grokboy-core/src/config.rs b/crates/grokboy-core/src/config.rs new file mode 100644 index 0000000..c8000ed --- /dev/null +++ b/crates/grokboy-core/src/config.rs @@ -0,0 +1,47 @@ +use std::env; + +#[derive(Debug, Clone)] +pub struct Config { + pub api_key: String, + pub base_url: String, + pub model: String, +} + +impl Config { + /// Resolve from environment. Prefers GROKBOY_*, then XAI_*, then OPENAI_*. + pub fn from_env() -> Result { + let api_key = env::var("GROKBOY_API_KEY") + .or_else(|_| env::var("XAI_API_KEY")) + .or_else(|_| env::var("OPENAI_API_KEY")) + .map_err(|_| { + "missing API key: set GROKBOY_API_KEY (or XAI_API_KEY / OPENAI_API_KEY)".to_string() + })?; + if api_key.trim().is_empty() { + return Err("API key is empty".into()); + } + let base_url = env::var("GROKBOY_BASE_URL") + .or_else(|_| env::var("OPENAI_BASE_URL")) + .unwrap_or_else(|_| "https://api.x.ai/v1".into()); + let model = env::var("GROKBOY_MODEL").unwrap_or_else(|_| "grok-4".into()); + Ok(Self { + api_key, + base_url: base_url.trim_end_matches('/').to_string(), + model, + }) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn rejects_missing_key() { + // Ensure we don't panic; actual env may have keys in CI — just type-check path. + let _ = Config { + api_key: "x".into(), + base_url: "https://api.x.ai/v1".into(), + model: "grok-4".into(), + }; + } +} diff --git a/crates/grokboy-core/src/lib.rs b/crates/grokboy-core/src/lib.rs new file mode 100644 index 0000000..c8052b8 --- /dev/null +++ b/crates/grokboy-core/src/lib.rs @@ -0,0 +1,7 @@ +//! GrokBoy core: config + OpenAI-compatible streaming chat. + +mod config; +mod model; + +pub use config::Config; +pub use model::{ChatMessage, Role, stream_chat}; diff --git a/crates/grokboy-core/src/model.rs b/crates/grokboy-core/src/model.rs new file mode 100644 index 0000000..1319a5c --- /dev/null +++ b/crates/grokboy-core/src/model.rs @@ -0,0 +1,155 @@ +use crate::config::Config; +use anyhow::{Context, Result, anyhow}; +use futures_util::StreamExt; +use serde::{Deserialize, Serialize}; +use serde_json::json; + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)] +#[serde(rename_all = "lowercase")] +pub enum Role { + System, + User, + Assistant, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +pub struct ChatMessage { + pub role: Role, + pub content: String, +} + +impl ChatMessage { + pub fn system(content: impl Into) -> Self { + Self { + role: Role::System, + content: content.into(), + } + } + pub fn user(content: impl Into) -> Self { + Self { + role: Role::User, + content: content.into(), + } + } + pub fn assistant(content: impl Into) -> Self { + Self { + role: Role::Assistant, + content: content.into(), + } + } +} + +#[derive(Debug, Deserialize)] +struct StreamChunk { + choices: Option>, + error: Option, +} + +#[derive(Debug, Deserialize)] +struct StreamChoice { + delta: Option, +} + +#[derive(Debug, Deserialize)] +struct Delta { + content: Option, +} + +#[derive(Debug, Deserialize)] +struct ApiErrorBody { + message: Option, +} + +/// Stream a chat completion; invoke `on_delta` for each text piece. +/// Returns the full assistant text. +pub async fn stream_chat( + config: &Config, + messages: &[ChatMessage], + mut on_delta: impl FnMut(&str), +) -> Result { + let client = reqwest::Client::new(); + let url = format!("{}/chat/completions", config.base_url); + let body = json!({ + "model": config.model, + "messages": messages, + "stream": true, + }); + + let response = client + .post(&url) + .bearer_auth(&config.api_key) + .header("content-type", "application/json") + .json(&body) + .send() + .await + .context("request to chat completions failed")?; + + if !response.status().is_success() { + let status = response.status(); + let text = response.text().await.unwrap_or_default(); + return Err(anyhow!("chat completions HTTP {status}: {text}")); + } + + let mut full = String::new(); + let mut stream = response.bytes_stream(); + let mut buffer = String::new(); + + while let Some(item) = stream.next().await { + let chunk = item.context("reading SSE stream")?; + buffer.push_str(&String::from_utf8_lossy(&chunk)); + + while let Some(pos) = buffer.find('\n') { + let mut line = buffer[..pos].to_string(); + buffer.drain(..=pos); + if line.ends_with('\r') { + line.pop(); + } + let line = line.trim(); + if line.is_empty() { + continue; + } + if !line.starts_with("data:") { + continue; + } + let data = line[5..].trim(); + if data == "[DONE]" { + return Ok(full); + } + let parsed: StreamChunk = match serde_json::from_str(data) { + Ok(v) => v, + Err(_) => continue, + }; + if let Some(err) = parsed.error { + return Err(anyhow!( + "provider error: {}", + err.message.unwrap_or_else(|| data.to_string()) + )); + } + if let Some(choices) = parsed.choices { + for choice in choices { + if let Some(delta) = choice.delta.and_then(|d| d.content) { + if !delta.is_empty() { + on_delta(&delta); + full.push_str(&delta); + } + } + } + } + } + } + + Ok(full) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn messages_serialize_roles() { + let msg = ChatMessage::user("hi"); + let v = serde_json::to_value(&msg).unwrap(); + assert_eq!(v["role"], "user"); + assert_eq!(v["content"], "hi"); + } +} diff --git a/crates/grokboy/Cargo.toml b/crates/grokboy/Cargo.toml new file mode 100644 index 0000000..03d6d89 --- /dev/null +++ b/crates/grokboy/Cargo.toml @@ -0,0 +1,15 @@ +[package] +name = "grokboy" +version.workspace = true +edition.workspace = true +license.workspace = true +description = "GrokBoy CLI — local chat agent" + +[[bin]] +name = "grokboy" +path = "src/main.rs" + +[dependencies] +anyhow.workspace = true +grokboy-core = { path = "../grokboy-core" } +tokio.workspace = true diff --git a/crates/grokboy/src/main.rs b/crates/grokboy/src/main.rs new file mode 100644 index 0000000..7081163 --- /dev/null +++ b/crates/grokboy/src/main.rs @@ -0,0 +1,90 @@ +use anyhow::{Context, Result}; +use grokboy_core::{ChatMessage, Config, stream_chat}; +use std::io::{self, Write}; +use std::process::ExitCode; + +const SYSTEM: &str = "You are GrokBoy, a concise local coding assistant. Prefer clear, short answers. Traditional Chinese is welcome when the user writes in Chinese."; + +#[tokio::main] +async fn main() -> ExitCode { + if let Err(err) = run().await { + eprintln!("error: {err:#}"); + return ExitCode::FAILURE; + } + ExitCode::SUCCESS +} + +async fn run() -> Result<()> { + let mut args = std::env::args().skip(1); + let cmd = args.next().unwrap_or_else(|| "help".into()); + match cmd.as_str() { + "chat" => cmd_chat().await, + "version" | "-V" | "--version" => { + println!("grokboy {}", env!("CARGO_PKG_VERSION")); + Ok(()) + } + "help" | "-h" | "--help" | _ => { + print_help(); + Ok(()) + } + } +} + +fn print_help() { + println!( + "\ +GrokBoy — minimal local CLI agent (P0: chat) + +USAGE: + grokboy chat Interactive streaming chat + grokboy version + grokboy help + +ENV: + GROKBOY_API_KEY API key (or XAI_API_KEY / OPENAI_API_KEY) + GROKBOY_BASE_URL default https://api.x.ai/v1 + GROKBOY_MODEL default grok-4 + +P0 has no tools yet. P1 will add shell/files + ReAct. +" + ); +} + +async fn cmd_chat() -> Result<()> { + let config = Config::from_env().map_err(anyhow::Error::msg)?; + println!( + "GrokBoy chat model={} base={}", + config.model, config.base_url + ); + println!("Type a message. Empty line or /exit to quit.\n"); + + let mut history = vec![ChatMessage::system(SYSTEM)]; + let stdin = io::stdin(); + let mut stdout = io::stdout(); + + loop { + print!("you> "); + stdout.flush().ok(); + let mut line = String::new(); + if stdin.read_line(&mut line).context("stdin")? == 0 { + println!(); + break; + } + let input = line.trim(); + if input.is_empty() || input == "/exit" || input == "/quit" { + break; + } + history.push(ChatMessage::user(input)); + + print!("assistant> "); + stdout.flush().ok(); + let reply = stream_chat(&config, &history, |delta| { + print!("{delta}"); + let _ = io::stdout().flush(); + }) + .await?; + println!("\n"); + history.push(ChatMessage::assistant(reply)); + } + Ok(()) +} diff --git a/docs/ACCEPTANCE.md b/docs/ACCEPTANCE.md new file mode 100644 index 0000000..d67c239 --- /dev/null +++ b/docs/ACCEPTANCE.md @@ -0,0 +1,22 @@ +# GrokBoy acceptance + +## P0 — streaming chat +- [x] Cargo workspace `grokboy-core` + `grokboy` +- [x] Env: `GROKBOY_API_KEY` / `XAI_API_KEY` / `OPENAI_API_KEY` +- [x] Default base `https://api.x.ai/v1` +- [x] `grokboy chat` streams assistant tokens +- [x] `cargo test` passes without API key + +## P1 — tools + ReAct (next) +- [ ] `shell`, `list_dir`, `read_file`, `write_file` +- [ ] Multi-step tool loop +- [ ] Sessions under `~/.grokboy/sessions/` +- [ ] `grokboy run` / `grokboy smoke` + +## P2 — completion contract +- [ ] `report_done` / blocked +- [ ] Loop guard +- [ ] Context truncation + +## P3 — browser +- [ ] Playwright DOM path (no screenshot-first)