ryo-query-language 0.1.0

RyoQL - Structured code query language for AI agents
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
68
69
70
71
72
73
74
75

# ryo-query-language

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

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

RyoQL — a structured code query language for AI agents. Solves the two failure
modes of free-text agent prompts: (1) the cost of putting requirements into
natural language, by giving a YAML / JSON schema; and (2) dead-end behaviour
when nothing matches, by surfacing `on_empty` hints and `suggestions` in the
response.

## Install

```sh
cargo add ryo-query-language
```

## Quickstart

```rust
use ryo_query_language::execute_yaml;

let yaml = r#"
kind: Function
match:
  name: process
  vis: Public
view: Snippet
"#;

// Execute against an analysis context
// let response = execute_yaml(yaml, &ctx)?;
```

YAML query schema (excerpt):

```yaml
kind: Function          # Function / Struct / Enum / Trait / Impl
match:                   # field-level predicates
  name: "process"
  vis: Public
  is_async: true
inner:                   # nested conditions
  - kind: ReturnType
    match: { name: "Result" }
resolve:                 # optional LSP-style relations
  type: References
scope:                   # search scope
  path: "src/**"
view: Snippet            # Snippet / Precise / Files / Count
```

## API Summary

| Module | Purpose |
|---|---|
| `schema::*` | YAML / JSON query schema types |
| `parser::{QueryParser, parse_view_mode}` | Text → typed query |
| `converter::{QueryConverter, CompositeQuery}` | Query → `DiscoveryQuery` |
| `executor::{execute_query, execute_yaml, QueryExecutor}` | Query execution |
| `filter::*` | Post-filter passes |
| `formatter::*` | Response formatting |

## Status

API surface considered stable for the v0.1.0 release.

## 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.