raytsystem

https://romarayt.github.io/raytsystem-public-os/
Admin
raytsystem is a local-first AI knowledge operating system that combines an immutable knowledge...
Tokens:142,698
Snippets:941
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install dependencies with uv sync --dev

Source: https://romarayt.github.io/raytsystem-public-os/getting-started/requirements

Installs project dependencies including development extras. Run this first to set up the environment.

```bash
uv sync --dev  
```

--------------------------------

### Локальный запуск Docusaurus сайта (npm install, start, build, serve)

Source: https://romarayt.github.io/raytsystem-public-os/development/documentation

Команды для локального запуска сайта из каталога website/. Сборка строгая: onBrokenLinks, onBrokenAnchors и onBrokenMarkdownLinks установлены в throw, поэтому любая битая ссылка валит npm run build. Поиск полностью локальный (плагин docusaurus-search-local), без обращений к сети.

```bash
npm install        # или npm ci для точной установки из lock-файла  

npm start          # dev-сервер с горячей перезагрузкой  

npm run build      # продакшн-сборка  

npm run serve      # отдать уже собранный сайт  
```

--------------------------------

### Start web panel with uv run raytsystem ui

Source: https://romarayt.github.io/raytsystem-public-os/getting-started/requirements

Starts the web panel on loopback at http://127.0.0.1:8765. In this release, raytsystem refuses to bind to non-loopback addresses.

```bash
uv run raytsystem ui  
```

--------------------------------

### raytsystem start

Source: https://romarayt.github.io/raytsystem-public-os/reference/cli

Start the raytsystem interface — short alias for `ui`. This command does not change state and does not require approval.

```APIDOC
## `raytsystem start`

### Description
Start the raytsystem interface — short alias for `ui`.

### Method
CLI command

### Command
`uv run raytsystem start`

### Parameters
- `root` (option) - Optional - Default: `(local path)`
- `host` (option) - Optional - Default: `127.0.0.1`
- `port` (option) - Optional - Default: `8765`
- `open_browser` (option) - Optional - Default: `True`

```

--------------------------------

### Serve MCP stdio: uv run raytsystem tool serve-mcp

Source: https://romarayt.github.io/raytsystem-public-os/agents/tool-hub

Starts the MCP stdio server. It supports MCP protocol versions 2024-11-05, 2025-03-26, and 2025-06-18. Requires initialize and notifications/initialized, then serves ping, tools/list, and tools/call.-RPC requests are limited to 16 MiB. Errors return limited messages without raw stderr, paths, tokens, or environment values.

```bash
uv run raytsystem tool serve-mcp --root .
```

--------------------------------

### Запуск loopback-only интерфейса через uv run raytsystem start

Source: https://romarayt.github.io/raytsystem-public-os/getting-started/installation

Запускает интерфейс, который слушает только на локальном loopback 127.0.0.1.

```bash
uv run raytsystem start  

```

--------------------------------

### raytsystem init

Source: https://romarayt.github.io/raytsystem-public-os/reference/cli

Initializes a new Rayt system project. Changes state and does not require approval.

```APIDOC
## `raytsystem init`

### Description
Initializes a new Rayt system project. Changes state and does not require approval.

### Method
CLI command

### Command
`uv run raytsystem init`

### Parameters
| Parameter | Type | Required | Default |
|-----------|------|----------|---------|
| `root` | option | no | `(local path)` |
| `template` | option | no | `software` |
| `dry_run` | option | no | `True` |
| `confirm_existing` | option | no | `False` |
| `json_output` | option | no | `False` |

### Example
```bash
uv run raytsystem init --help
```
```

--------------------------------

### GET /api/v1/agents

Source: https://romarayt.github.io/raytsystem-public-os/reference/api

Retrieves the list of all agents with their definitions and execution state.

```APIDOC
## GET /api/v1/agents

### Description
Returns a list of all agents with their definitions and nullable execution state.

### Method
GET

### Endpoint
/api/v1/agents

### Response
#### Success Response (200)
- **definition** (object) - Agent definition.
- **execution** (object|null) - Execution state, nullable.
- **readiness** (string) - Readiness status.
- **runtime summary** (object) - Safe runtime summary.

#### Response Example
{
  "definition": {},
  "execution": null,
  "readiness": "ready",
  "runtime_summary": {}
}
```

--------------------------------

### GET /api/v1/skills

Source: https://romarayt.github.io/raytsystem-public-os/reference/api

Retrieves the list of skills with their edit/fork policy and related agent.

```APIDOC
## GET /api/v1/skills

### Description
Returns a list of skills with edit/fork policy and related agent.

### Method
GET

### Endpoint
/api/v1/skills

### Response
#### Success Response (200)
- **definitions** (array) - Skill definitions.
- **safe relative source path** (string) - Safe relative source path.
- **editable** (boolean) - Whether the skill is editable.
- **read_only_reason** (string|null) - Reason for read-only status.
- **forkable** (boolean) - Whether the skill is forkable.
- **related Agent** (object) - Related agent.

#### Response Example
{
  "definitions": [],
  "source_path": "skills/example.md",
  "editable": true,
  "read_only_reason": null,
  "forkable": true,
  "related_agent": {}
}
```

--------------------------------

### Команды CLI raytsystem task: list, create, transition

Source: https://romarayt.github.io/raytsystem-public-os/interface/tasks

Команды для работы с задачами из терминала: task list — просмотр без изменений, task create — создание задачи, task transition — перевод между статусами. Это те же изменяющие операции, что и в интерфейсе, и они проходят через локальный API с проверкой ожидаемого поколения. Для просмотра без изменений используйте task list.

```bash

uv run raytsystem task list  

uv run raytsystem task create  

uv run raytsystem task transition  


```

--------------------------------

### GET /api/v1/skills/{skill_id}

Source: https://romarayt.github.io/raytsystem-public-os/reference/api

Retrieves detailed information about a specific skill, including its content and permission boundary.

```APIDOC
## GET /api/v1/skills/{skill_id}

### Description
Returns skill detail and allowed inert Markdown content.

### Method
GET

### Endpoint
/api/v1/skills/{skill_id}

### Parameters
#### Path Parameters
- **skill_id** (string) - Required - The skill identifier.

#### Query Parameters
- **expected** (string) - Required - Catalog SHA-256 hash.

### Response
#### Success Response (200)
- **content** (string|null) - Skill content; null if content is restricted.
- **source.content_restricted** (boolean) - Indicates if content is restricted.
- **permission_boundary** (object) - Declared permission IDs and typed sections.
- **history** (object) - Current authoring revision if present.

#### Response Example
{
  "content": "# Skill\n...",
  "source": {
    "content_restricted": false
  },
  "permission_boundary": {},
  "history": {}
}
```

--------------------------------

### Пример перехода READY -> RUNNING с актуальным поколением

Source: https://romarayt.github.io/raytsystem-public-os/troubleshooting/task-not-transitioning

Демонстрирует легальный переход задачи из READY в RUNNING с указанием idempotency-key и expected-generation. Команда возвращает новый generation_id и увеличенный revision.

```bash
# Посмотреть текущее поколение и статусы

uv run raytsystem task list --json

# Легальный переход READY -> RUNNING с актуальным поколением

uv run raytsystem task transition task_XXXX running \
  --idempotency-key move-1 \
  --expected-generation tgen_XXXX
```

--------------------------------

### GET /api/v1/agents/{agent_id}

Source: https://romarayt.github.io/raytsystem-public-os/reference/api

Retrieves a detailed projection of a specific agent, including overview, instruction, skills, runtime, access, and history.

```APIDOC
## GET /api/v1/agents/{agent_id}

### Description
Returns a safe agent detail projection bound to a catalog hash.

### Method
GET

### Endpoint
/api/v1/agents/{agent_id}

### Parameters
#### Path Parameters
- **agent_id** (string) - Required - The agent identifier.

#### Query Parameters
- **expected** (string) - Required - Catalog SHA-256 hash.

### Response
#### Success Response (200)
- **Overview** (object) - Overview section.
- **Instruction** (object) - Instruction section.
- **Skills** (object) - Skills section.
- **Runtime** (object) - Runtime section.
- **Access** (object) - Access section.
- **History** (object) - History section.

#### Response Example
{
  "overview": {},
  "instruction": {},
  "skills": {},
  "runtime": {},
  "access": {},
  "history": {}
}
```
Tokens:
Raw