ten-framework Agent Skills & AI Rules

GitHub

Open-source framework for conversational voice AI agents

11,180 stars Python Python 1 file ยท ~200,161 tokens #ai#multi-modal#real-time#video#voice
RAW Rules
5 Discovered Rules โ€ข ~1,697 Estimated Tokens
Quick:
Loading skill content...

AI Agent Protocol & Instructions

AGENTS.md root-instruction ~779 tokens
Raw
# AI Agent Instructions

This repository uses progressive disclosure documentation to help AI coding
agents work efficiently. Documentation is structured in three levels under
`docs/ai/`.

## How to Load

1. Read [docs/ai/L0_repo_card.md](docs/ai/L0_repo_card.md) to identify the repo.
2. Load ALL 8 files in `docs/ai/L1/`. They are small โ€” load all of them upfront.
   This gives you setup, architecture, code map, conventions, workflows,
   interfaces, gotchas, and security.
3. If a task needs more detail than L1 provides, follow links to L2 deep dives
   in `docs/ai/L1/deep_dives/`. Load only the specific L2 file you need.

## Levels

- **L0 (Repo Card):** Identity and L1 index. Table of contents.
- **L1 (Summaries):** Eight structured summaries. Load all at session start.
- **L2 (Deep Dives):** Full specifications. Load only when L1 isn't detailed enough.

## Git Conventions

### Commit messages โ€” conventional commits

- **Format:** `type: description` or `type(scope): description`
- **Types:** `feat:` (new feature), `fix:` (bug fix), `chore:` (maintenance, version bumps), `test:` (test additions/changes), `docs:` (documentation)
- **Scoped variant:** `feat(scope):`, `fix(scope):` โ€” e.g. `feat(auth): add token refresh`
- **Lowercase after prefix** โ€” `feat: add feature`, not `feat: Add feature`
- **Present tense** โ€” "add feature", not "added feature"
- **PR number appended** โ€” `feat: add feature (#123)`

### Branch names

- **Format:** `type/short-description` โ€” lowercase, hyphen-separated
- **Types match commit types:** `feat/`, `fix/`, `chore/`, `test/`, `docs/`
- **Examples:** `feat/token-refresh`, `fix/null-pointer`, `docs/progressive-disclosure`

### General rules

- **No AI tool names** โ€” never mention claude, cursor, copilot, cody, aider, gemini, codex, chatgpt, or gpt-3/4
- **No Co-Authored-By trailers** โ€” omit AI attribution lines
- **No --no-verify** โ€” let git hooks run normally
- **No git config changes** โ€” do not modify user.name or user.email

## Doc Commands

| Command       | When to use                                   |
| ------------- | --------------------------------------------- |
| generate docs | no `docs/ai/` directory exists yet            |
| update docs   | code changed since last `last_reviewed` date  |
| test docs     | verify docs give agents the right context     |

For detailed procedures, read
[progressive-disclosure-standard.md](docs/progressive-disclosure-standard.md)
sections 6 (generate) and 7 (bootstrap).

## Working Areas

- `ai_agents/` โ€” primary area for agents, examples, server, integrations
- `core/`, `packages/`, `build/` โ€” framework internals

## Domain Skills

- For pull-request or diff reviews of implementation, configuration, dependency,
  or test changes inside `ai_agents/agents/ten_packages/extension/<tts-extension>/`,
  load and follow
  [ten-tts-review](.agents/skills/ten-tts-review/SKILL.md).
- Do not apply that skill to `ten_ai_base`, `tts_guarder`, examples, graphs, or
  paths outside the TTS extension directory.