mirror of
https://github.com/agentscope-ai/ReMe.git
synced 2026-10-16 04:33:12 +00:00
d865776edd
Some checks are pending
CI / Python packages / Build and verify distributions (push) Waiting to run
CI / Python quality / GitHub Actions (push) Waiting to run
CI / Python quality / Pre-commit (push) Waiting to run
CI / Python tests / Unit Tests - py3.11 (push) Waiting to run
CI / Python tests / Unit Tests - py3.13 (push) Waiting to run
CI / Python tests / Unit Tests - py3.14 (push) Waiting to run
CI / Windows / CLI smoke - py3.11 (push) Waiting to run
Deploy / Documentation / Build documentation (push) Waiting to run
CI and Release / Docker / Publish multi-platform tags (push) Blocked by required conditions
Security / CodeQL / Analyze javascript-typescript (push) Waiting to run
Security / CodeQL / Analyze python (push) Waiting to run
CI / Python tests / Unit Tests - py3.12 (push) Waiting to run
CI / ReMe Studio / Studio checks (push) Waiting to run
Deploy / Documentation / deploy (push) Blocked by required conditions
CI and Release / Docker / Build and test / amd64 (push) Waiting to run
CI and Release / Docker / Build and test / arm64 (push) Waiting to run
100 lines
2.5 KiB
Markdown
100 lines
2.5 KiB
Markdown
---
|
|
title: CLI Reference
|
|
description: ReMe command syntax, service invocation, configuration overrides, and plugin commands.
|
|
---
|
|
|
|
# CLI Reference
|
|
|
|
The basic syntax is:
|
|
|
|
```text
|
|
reme ACTION key=value ...
|
|
```
|
|
|
|
## Start an Application
|
|
|
|
Use two stages: start a service in one terminal, then call Jobs from another. Choose one startup command and leave it
|
|
running:
|
|
|
|
```bash
|
|
reme start
|
|
reme start config=demo
|
|
reme start workspace_dir=/data/reme service.port=8181
|
|
```
|
|
|
|
Plain `start` runs the configured Service. Omit `config` to use `default`; select another configuration when needed.
|
|
|
|
## Call Jobs
|
|
|
|
In another terminal, each action name is a Job name. The CLI discovers the running service configuration:
|
|
|
|
```bash
|
|
reme help
|
|
reme health_check
|
|
reme search query="project decision" limit=10
|
|
reme read path=digest/wiki/project.md start_line=1 end_line=80
|
|
```
|
|
|
|
Use JSON for structured values:
|
|
|
|
```bash
|
|
reme auto_memory \
|
|
session_id=example \
|
|
messages='[{"role":"user","content":"Remember this preference"}]'
|
|
```
|
|
|
|
Client-selection arguments—`backend`, `transport`, `host`, `port`, `timeout`, `command`, `args`, and `show_metadata`—configure the client and never leak into the Job payload.
|
|
|
|
## Configuration overrides
|
|
|
|
```bash
|
|
reme start \
|
|
config=/path/to/custom.yaml \
|
|
service.port=8181 \
|
|
service.web_enabled=false \
|
|
plugins='["auto-fin"]'
|
|
```
|
|
|
|
Leading `-` or `--` is optional. Use dots for nested keys and JSON for arrays and objects.
|
|
|
|
## Service discovery
|
|
|
|
```bash
|
|
reme find_reme
|
|
```
|
|
|
|
This reports a discovered service but never starts or replaces a process.
|
|
|
|
## Plugin commands
|
|
|
|
Package management runs locally rather than through HTTP or MCP:
|
|
|
|
```bash
|
|
reme plugins list
|
|
reme plugins show auto-fin
|
|
reme plugins validate auto-fin
|
|
reme plugins install plugins/auto-fin
|
|
reme plugins uninstall auto-fin
|
|
```
|
|
|
|
See [Plugin Management](../plugin_management.md) for the complete workflow.
|
|
|
|
## Discover active capabilities
|
|
|
|
The [Job API Reference](./jobs.md) describes the default configuration. Plugins and custom YAML may change the running service, so automation should prefer:
|
|
|
|
```bash
|
|
reme help
|
|
reme app_config
|
|
```
|
|
|
|
## Run Once Without a Persistent Service
|
|
|
|
For a script that needs to execute one Job and exit, use the one-shot CLI Service:
|
|
|
|
```bash
|
|
reme start config=default job=search query="keywords" limit=5
|
|
```
|
|
|
|
`start job=<name>` runs the Job locally through the normal application lifecycle and then exits. It does not call an
|
|
already running service. Normal interactive examples use the two-stage workflow above.
|