README.en.md

简体中文 | English

yaa

yaa means Yet Another Agent, which can analyze and understand natural language instructions and automatically create, plan, execute, and check tasks.

Quick Start

Client

View

Server

Deployment

Deploy locally:

# Clone project repository to local
git clone https://github.com/Byte-tea/yaa.git
# Enter project directory
cd yaa

Configuration:

# Create client config file (will override default config when passed)
cp configs/Config.example.json Config.json
# Create server config file (will override default config when passed)
cp configs/ServerConfig.example.json ServerConfig.json

Usage

Start in server mode:

cargo run --release -- --serve --port 12345 --config Config.json

Start in interactive CLI mode:

cargo run --release -- --config Config.json
> Please write a bubble sort algorithm in Python.
* Working on it...

Contribute

See CONTRIBUTING.md for details.

Project Implementation

See yaa documentation for details.

License

MIT License

Additional Licenses

Client Dependencies

Name	License
tabler-icons	MIT License
markedjs/marked	marked License
mermaidjs/mermaid	MIT License

Server Dependencies

Name	License
actix-cors	MIT License
actix-web	MIT License
anyhow	MIT License
async-trait	MIT License
chrono	MIT License
clap	MIT License
reqwest	MIT License
serde	MIT License
serde_json	MIT License
thiserror	MIT License
tokio	MIT License
uuid	MIT License
wasi	Apache-2.0 License
wasm-bindgen	Apache-2.0 License