ryo-app 0.1.0

[preview] Application layer for RYO - Project management, Intent handling, API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

# ryo-app

[![crates.io](https://img.shields.io/crates/v/ryo-app.svg)](https://crates.io/crates/ryo-app)
[![docs.rs](https://docs.rs/ryo-app/badge.svg)](https://docs.rs/ryo-app)
[![License: MIT OR Apache-2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](#license)

> **Status:** preview. Reader API stable, Writer API experimental.
> Part of the [ryo](https://github.com/ynishi/ryo-rs) workspace —
> AST-centric Rust programming for AI agents.

Application layer for ryo: project management (in-memory AST collection
with I/O), `Intent` / `Goal` (user-intention representation with JSON
Schema for LLM integration), `Api` (the external interface for CLI / UI /
Agent), and a `Storage` trait for dependency injection.

## Install

```sh
cargo add ryo-app
```

Optional features: `schemars` (JSON Schema derive), `fuzzy-parser`
(LLM-typo repair via `ryo-fuzzy-parser`), `literal-search` (full-text via
`tantivy`).

## Quickstart

```rust,ignore
use ryo_app::{Api, Project, Goal, Intent, IdentKind, Pattern, InMemoryStorage};

let mut project = Project::from_dir("src/")?;

let storage = Box::new(InMemoryStorage::new());
let mut api = Api::new(storage);

let goal = Goal::new(Intent::RenameIdent {
    from: Pattern::exact("old_name"),
    to: "new_name".to_string(),
    kind: IdentKind::Any,
});

let result = api.execute(&mut project, goal)?;
```

## API Summary

| Item | Purpose |
|---|---|
| `Api` | External interface (executor + storage DI) |
| `Project` | In-memory AST file collection with I/O |
| `Intent` / `Goal` | User intention types (JSON-schema-able) |
| `Storage` trait + `InMemoryStorage` / `FileUuidStorage` | Persistence DI |
| `Planner` / `PlanError` | Goal planning |
| `DiscoverService` / `SpecService` | Reader-side facades |
| `Format` / `TxLogMode` (re-exported from `ryo-storage`) | Storage formats |

## Status

**Preview.** Reader-side APIs (`DiscoverService`, `SpecService`, queries)
are considered stable for v0.1.0. Writer-side APIs (`Api::execute` against
mutation goals) depend on the experimental
[`ryo-executor`](https://crates.io/crates/ryo-executor) and may evolve.

## License

Licensed under either of [Apache-2.0](https://github.com/ynishi/ryo-rs/blob/main/LICENSE-APACHE)
or [MIT](https://github.com/ynishi/ryo-rs/blob/main/LICENSE-MIT) at your option.