objectiveai_sdk/cli/command/agents/logs/
mod.rs

1//! `agents logs` — persisted log tier. Leaves:
2//!
3//! - `open --id <id>` — look up a single logged row by its
4//!   `logs.messages."index"`.
5//! - `list --all | --pending` — stream logged rows for the targets:
6//!   `--all` is every row, `--pending` is the unfinalized rows only.
7//! - `subscribe` — long-lived stream of new rows as they land.
8
9use crate::cli::command::CommandRequest;
10
11pub mod list;
12pub mod open;
13pub mod subscribe;
14pub mod token_usage;
15
16#[derive(clap::Subcommand)]
17pub enum Command {
18    /// Look up a single logged row by its `logs.messages."index"`.
19    Open(open::Command),
20    /// Stream logged rows for the targets (`--all` / `--pending`).
21    List(list::Command),
22    /// Subscribe to live updates for the given agents.
23    Subscribe(subscribe::Command),
24    /// Per-AIH token-usage snapshot — `subscribe`.
25    TokenUsage {
26        #[command(subcommand)]
27        command: token_usage::Command,
28    },
29}
30
31#[derive(Debug, Clone, serde::Serialize, serde::Deserialize, schemars::JsonSchema)]
32#[serde(untagged)]
33#[schemars(rename = "cli.command.agents.logs.Request")]
34pub enum Request {
35    #[schemars(title = "Open")]
36    Open(open::Request),
37    #[schemars(title = "OpenRequestSchema")]
38    OpenRequestSchema(open::request_schema::Request),
39    #[schemars(title = "OpenResponseSchema")]
40    OpenResponseSchema(open::response_schema::Request),
41    #[schemars(title = "List")]
42    List(list::Request),
43    #[schemars(title = "ListRequestSchema")]
44    ListRequestSchema(list::request_schema::Request),
45    #[schemars(title = "ListResponseSchema")]
46    ListResponseSchema(list::response_schema::Request),
47    #[schemars(title = "Subscribe")]
48    Subscribe(subscribe::Request),
49    #[schemars(title = "SubscribeRequestSchema")]
50    SubscribeRequestSchema(subscribe::request_schema::Request),
51    #[schemars(title = "SubscribeResponseSchema")]
52    SubscribeResponseSchema(subscribe::response_schema::Request),
53    #[schemars(title = "TokenUsage")]
54    TokenUsage(token_usage::Request),
55}
56
57// Exempt from json-schema coverage: tier aggregate (see the root
58// `ResponseItem` in command.rs - TS7056).
59#[objectiveai_sdk_macros::json_schema_ignore]
60#[derive(Debug, Clone, serde::Serialize, serde::Deserialize, schemars::JsonSchema)]
61#[schemars(rename = "cli.command.agents.logs.ResponseItem")]
62#[serde(untagged)]
63pub enum ResponseItem {
64    #[schemars(title = "Open")]
65    Open(open::Response),
66    #[schemars(title = "OpenRequestSchema")]
67    OpenRequestSchema(open::request_schema::Response),
68    #[schemars(title = "OpenResponseSchema")]
69    OpenResponseSchema(open::response_schema::Response),
70    #[schemars(title = "List")]
71    List(list::ResponseItem),
72    #[schemars(title = "ListRequestSchema")]
73    ListRequestSchema(list::request_schema::Response),
74    #[schemars(title = "ListResponseSchema")]
75    ListResponseSchema(list::response_schema::Response),
76    #[schemars(title = "Subscribe")]
77    Subscribe(subscribe::ResponseItem),
78    #[schemars(title = "SubscribeRequestSchema")]
79    SubscribeRequestSchema(subscribe::request_schema::Response),
80    #[schemars(title = "SubscribeResponseSchema")]
81    SubscribeResponseSchema(subscribe::response_schema::Response),
82    #[schemars(title = "TokenUsage")]
83    TokenUsage(token_usage::ResponseItem),
84}
85
86#[cfg(feature = "mcp")]
87impl crate::cli::command::CommandResponse for ResponseItem {
88    fn into_mcp(self) -> crate::cli::command::McpResponseItem {
89        match self {
90            ResponseItem::Open(v) => v.into_mcp(),
91            ResponseItem::OpenRequestSchema(v) => v.into_mcp(),
92            ResponseItem::OpenResponseSchema(v) => v.into_mcp(),
93            ResponseItem::List(v) => v.into_mcp(),
94            ResponseItem::ListRequestSchema(v) => v.into_mcp(),
95            ResponseItem::ListResponseSchema(v) => v.into_mcp(),
96            ResponseItem::Subscribe(v) => v.into_mcp(),
97            ResponseItem::SubscribeRequestSchema(v) => v.into_mcp(),
98            ResponseItem::SubscribeResponseSchema(v) => v.into_mcp(),
99            ResponseItem::TokenUsage(v) => v.into_mcp(),
100        }
101    }
102}
103
104impl TryFrom<Command> for Request {
105    type Error = crate::cli::command::FromArgsError;
106    fn try_from(command: Command) -> Result<Self, Self::Error> {
107        match command {
108            Command::Open(cmd) => match cmd.schema {
109                None => Ok(Request::Open(open::Request::try_from(cmd.args)?)),
110                Some(open::Schema::RequestSchema(args)) => Ok(
111                    Request::OpenRequestSchema(open::request_schema::Request::try_from(args)?),
112                ),
113                Some(open::Schema::ResponseSchema(args)) => Ok(
114                    Request::OpenResponseSchema(open::response_schema::Request::try_from(args)?),
115                ),
116            },
117            Command::List(cmd) => match cmd.schema {
118                None => Ok(Request::List(list::Request::try_from(cmd.args)?)),
119                Some(list::Schema::RequestSchema(args)) => Ok(
120                    Request::ListRequestSchema(list::request_schema::Request::try_from(args)?),
121                ),
122                Some(list::Schema::ResponseSchema(args)) => Ok(
123                    Request::ListResponseSchema(list::response_schema::Request::try_from(args)?),
124                ),
125            },
126            Command::Subscribe(cmd) => match cmd.schema {
127                None => Ok(Request::Subscribe(subscribe::Request::try_from(cmd.args)?)),
128                Some(subscribe::Schema::RequestSchema(args)) => Ok(
129                    Request::SubscribeRequestSchema(subscribe::request_schema::Request::try_from(args)?),
130                ),
131                Some(subscribe::Schema::ResponseSchema(args)) => Ok(
132                    Request::SubscribeResponseSchema(subscribe::response_schema::Request::try_from(args)?),
133                ),
134            },
135            Command::TokenUsage { command } => {
136                Ok(Request::TokenUsage(token_usage::Request::try_from(command)?))
137            }
138        }
139    }
140}
141
142impl CommandRequest for Request {
143    fn request_base(&self) -> &crate::cli::command::RequestBase {
144        match self {
145            Request::Open(inner) => inner.request_base(),
146            Request::OpenRequestSchema(inner) => inner.request_base(),
147            Request::OpenResponseSchema(inner) => inner.request_base(),
148            Request::List(inner) => inner.request_base(),
149            Request::ListRequestSchema(inner) => inner.request_base(),
150            Request::ListResponseSchema(inner) => inner.request_base(),
151            Request::Subscribe(inner) => inner.request_base(),
152            Request::SubscribeRequestSchema(inner) => inner.request_base(),
153            Request::SubscribeResponseSchema(inner) => inner.request_base(),
154            Request::TokenUsage(inner) => inner.request_base(),
155        }
156    }
157
158    fn request_base_mut(&mut self) -> Option<&mut crate::cli::command::RequestBase> {
159        match self {
160            Request::Open(inner) => inner.request_base_mut(),
161            Request::OpenRequestSchema(inner) => inner.request_base_mut(),
162            Request::OpenResponseSchema(inner) => inner.request_base_mut(),
163            Request::List(inner) => inner.request_base_mut(),
164            Request::ListRequestSchema(inner) => inner.request_base_mut(),
165            Request::ListResponseSchema(inner) => inner.request_base_mut(),
166            Request::Subscribe(inner) => inner.request_base_mut(),
167            Request::SubscribeRequestSchema(inner) => inner.request_base_mut(),
168            Request::SubscribeResponseSchema(inner) => inner.request_base_mut(),
169            Request::TokenUsage(inner) => inner.request_base_mut(),
170        }
171    }
172}
173
174#[cfg(feature = "cli-executor")]
175pub async fn execute<E: crate::cli::command::CommandExecutor>(
176    executor: &E,
177    request: Request,
178    agent_arguments: Option<&crate::cli::command::AgentArguments>,
179) -> Result<
180    std::pin::Pin<Box<dyn futures::Stream<Item = Result<ResponseItem, E::Error>> + Send>>,
181    E::Error,
182> {
183    use futures::StreamExt;
184    let stream: std::pin::Pin<
185        Box<dyn futures::Stream<Item = Result<ResponseItem, E::Error>> + Send>,
186    > = match request {
187        Request::Open(req) => {
188            let value = open::execute(executor, req, agent_arguments).await?;
189            Box::pin(crate::cli::command::StreamOnce::new(Ok(
190                ResponseItem::Open(value),
191            )))
192        }
193        Request::OpenRequestSchema(req) => {
194            let value = open::request_schema::execute(executor, req, agent_arguments).await?;
195            Box::pin(crate::cli::command::StreamOnce::new(Ok(
196                ResponseItem::OpenRequestSchema(value),
197            )))
198        }
199        Request::OpenResponseSchema(req) => {
200            let value = open::response_schema::execute(executor, req, agent_arguments).await?;
201            Box::pin(crate::cli::command::StreamOnce::new(Ok(
202                ResponseItem::OpenResponseSchema(value),
203            )))
204        }
205        Request::List(req) => {
206            let inner = list::execute(executor, req, agent_arguments).await?;
207            Box::pin(inner.map(|r| r.map(ResponseItem::List)))
208        }
209        Request::ListRequestSchema(req) => {
210            let value = list::request_schema::execute(executor, req, agent_arguments).await?;
211            Box::pin(crate::cli::command::StreamOnce::new(Ok(
212                ResponseItem::ListRequestSchema(value),
213            )))
214        }
215        Request::ListResponseSchema(req) => {
216            let value = list::response_schema::execute(executor, req, agent_arguments).await?;
217            Box::pin(crate::cli::command::StreamOnce::new(Ok(
218                ResponseItem::ListResponseSchema(value),
219            )))
220        }
221        Request::Subscribe(req) => {
222            let inner = subscribe::execute(executor, req, agent_arguments).await?;
223            Box::pin(inner.map(|r| r.map(ResponseItem::Subscribe)))
224        }
225        Request::SubscribeRequestSchema(req) => {
226            let value = subscribe::request_schema::execute(executor, req, agent_arguments).await?;
227            Box::pin(crate::cli::command::StreamOnce::new(Ok(
228                ResponseItem::SubscribeRequestSchema(value),
229            )))
230        }
231        Request::SubscribeResponseSchema(req) => {
232            let value = subscribe::response_schema::execute(executor, req, agent_arguments).await?;
233            Box::pin(crate::cli::command::StreamOnce::new(Ok(
234                ResponseItem::SubscribeResponseSchema(value),
235            )))
236        }
237        Request::TokenUsage(req) => {
238            let inner = token_usage::execute(executor, req, agent_arguments).await?;
239            Box::pin(inner.map(|r| r.map(ResponseItem::TokenUsage)))
240        }
241    };
242    Ok(stream)
243}
244
245#[cfg(feature = "cli-executor")]
246pub async fn execute_transform<E: crate::cli::command::CommandExecutor>(
247    executor: &E,
248    request: Request,
249    transform: crate::cli::command::Transform,
250    agent_arguments: Option<&crate::cli::command::AgentArguments>,
251) -> Result<
252    std::pin::Pin<Box<dyn futures::Stream<Item = Result<serde_json::Value, E::Error>> + Send>>,
253    E::Error,
254> {
255    let stream: std::pin::Pin<
256        Box<dyn futures::Stream<Item = Result<serde_json::Value, E::Error>> + Send>,
257    > = match request {
258        Request::Open(req) => {
259            let value = open::execute_transform(executor, req, transform, agent_arguments).await?;
260            Box::pin(crate::cli::command::StreamOnce::new(Ok(value)))
261        }
262        Request::OpenRequestSchema(req) => {
263            let value =
264                open::request_schema::execute_transform(executor, req, transform, agent_arguments).await?;
265            Box::pin(crate::cli::command::StreamOnce::new(Ok(value)))
266        }
267        Request::OpenResponseSchema(req) => {
268            let value =
269                open::response_schema::execute_transform(executor, req, transform, agent_arguments).await?;
270            Box::pin(crate::cli::command::StreamOnce::new(Ok(value)))
271        }
272        Request::List(req) => {
273            let inner = list::execute_transform(executor, req, transform, agent_arguments).await?;
274            Box::pin(inner)
275        }
276        Request::ListRequestSchema(req) => {
277            let value =
278                list::request_schema::execute_transform(executor, req, transform, agent_arguments).await?;
279            Box::pin(crate::cli::command::StreamOnce::new(Ok(value)))
280        }
281        Request::ListResponseSchema(req) => {
282            let value =
283                list::response_schema::execute_transform(executor, req, transform, agent_arguments).await?;
284            Box::pin(crate::cli::command::StreamOnce::new(Ok(value)))
285        }
286        Request::Subscribe(req) => {
287            let inner = subscribe::execute_transform(executor, req, transform, agent_arguments).await?;
288            Box::pin(inner)
289        }
290        Request::SubscribeRequestSchema(req) => {
291            let value =
292                subscribe::request_schema::execute_transform(executor, req, transform, agent_arguments).await?;
293            Box::pin(crate::cli::command::StreamOnce::new(Ok(value)))
294        }
295        Request::SubscribeResponseSchema(req) => {
296            let value =
297                subscribe::response_schema::execute_transform(executor, req, transform, agent_arguments).await?;
298            Box::pin(crate::cli::command::StreamOnce::new(Ok(value)))
299        }
300        Request::TokenUsage(req) => {
301            let inner = token_usage::execute_transform(executor, req, transform, agent_arguments).await?;
302            Box::pin(inner)
303        }
304    };
305    Ok(stream)
306}
307
308/// `/listen` mirror of [`Request`]: one variant per child, wrapping
309/// its `ListenerExecution`. See [`crate::cli::websocket_listener`].
310#[cfg(feature = "cli-listener")]
311pub enum ListenerExecution {
312    Open(open::ListenerExecution),
313    OpenRequestSchema(open::request_schema::ListenerExecution),
314    OpenResponseSchema(open::response_schema::ListenerExecution),
315    List(list::ListenerExecution),
316    ListRequestSchema(list::request_schema::ListenerExecution),
317    ListResponseSchema(list::response_schema::ListenerExecution),
318    Subscribe(subscribe::ListenerExecution),
319    SubscribeRequestSchema(subscribe::request_schema::ListenerExecution),
320    SubscribeResponseSchema(subscribe::response_schema::ListenerExecution),
321    TokenUsage(token_usage::ListenerExecution),
322}
objectiveai_sdk/cli/command/agents/logs/mod.rs

objectiveai_sdk/cli/command/agents/logs/
mod.rs
