Metadata-Version: 2.4
Name: arm101-cli
Version: 0.5.0
Summary: Agent and CLI for controlling SO-ARM101 robotic arm grippers
Project-URL: Homepage, https://github.com/agentculture/arm101-cli
Project-URL: Issues, https://github.com/agentculture/arm101-cli/issues
Author: AgentCulture
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development
Requires-Python: >=3.12
Provides-Extra: hardware
Requires-Dist: feetech-servo-sdk>=1.0; extra == 'hardware'
Provides-Extra: mac
Requires-Dist: pyserial>=3.5; extra == 'mac'
Provides-Extra: win
Requires-Dist: pyserial>=3.5; extra == 'win'
Description-Content-Type: text/markdown

# arm101-cli

Agent and CLI for controlling SO-ARM101 robotic arm grippers

## What you get

- **An agent-first CLI** cited from [teken](https://github.com/agentculture/teken)
  (`afi-cli`) — the runtime package has no third-party dependencies.
- **A mesh identity** — `culture.yaml` (`suffix` + `backend`) and the matching
  prompt file (`AGENTS.colleague.md` for this agent's `backend: colleague`).
- **The canonical guildmaster skill kit** (11 skills) under `.claude/skills/`,
  vendored cite-don't-import. See [`docs/skill-sources.md`](docs/skill-sources.md).
- **A build + deploy baseline** — pytest, lint, the agent-first rubric gate, and
  PyPI Trusted Publishing wired into GitHub Actions.

## Installation

Base install (zero third-party runtime dependencies — introspection only):

```bash
uv sync          # or: pip install arm101-cli
```

For real Feetech STS3215 motor I/O, add the `[hardware]` extra:

```bash
uv sync --extra hardware          # or: pip install 'arm101-cli[hardware]'
```

This pulls in `feetech-servo-sdk` (import module `scservo_sdk`), which the bus
adapter lazy-imports. The base install stays zero-dep so the CLI and agent
introspection work on any machine without hardware attached.

## Quickstart

```bash
uv sync
uv run pytest -n auto                 # run the test suite
uv run arm101 whoami                 # identity from culture.yaml (console script is 'arm101')
uv run arm101 learn                  # self-teaching prompt (add --json)
uv run teken cli doctor . --strict    # the agent-first rubric gate CI runs
```

## CLI

| Verb | What it does |
|------|--------------|
| `whoami` | Report this agent's nick, version, backend, and model from `culture.yaml`. |
| `learn` | Print a structured self-teaching prompt. |
| `explain <path>` | Markdown docs for any noun/verb path. |
| `overview` | Read-only descriptive snapshot of the agent. |
| `doctor` | Check the agent-identity invariants (prompt-file-present, backend-consistency). |
| `cli overview` | Describe the CLI surface itself. |

Every command supports `--json`. Results go to stdout, errors/diagnostics to
stderr (never mixed). Exit codes: `0` success, `1` user error, `2` environment
error, `3+` reserved.

## Make it your own

1. Rename the package `arm101/` and the `arm101-cli`
   CLI/dist name throughout `pyproject.toml`, the package, `tests/`,
   `sonar-project.properties`, and this `README.md`. The name is hard-coded in
   ~100 places, so list every occurrence first — see the `git grep` discovery
   command in [`CLAUDE.md`](CLAUDE.md), the authoritative rename procedure.
2. Edit `culture.yaml` with your `suffix` and `backend`.
3. Rewrite `CLAUDE.md` for your agent and run `/init`.
4. Re-vendor only the skills you need from guildmaster (see
   [`docs/skill-sources.md`](docs/skill-sources.md)).

See [`CLAUDE.md`](CLAUDE.md) for the full conventions (version-bump-every-PR,
the `cicd` PR lane, deploy setup).

## License

Apache 2.0 — see [`LICENSE`](LICENSE).
