> For the complete documentation index, see [llms.txt](https://docs.telys.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.telys.ai/cli/overview.md). # Overview `telys` signs you in, installs and verifies the signed runtime, serves a collection over a socket, runs the MCP server, and drives a local memory store from the shell. `pipx install telys` (or `pip install telys`) installs it as the `telys` console script (`telys = telys.cli:main`). Every subcommand runs on your machine. The CLI is a thin front end over the `telys` SDK; the vector engine is the signed native runtime, loaded lazily. ## Synopsis ``` telys # prints help, exits 0 telys login [--token] [--plan] [--no-install] [--no-browser] telys version # "telys (format v)" telys runtime {status | install | verify | update} telys serve --path PATH (--socket SOCKET | --host HOST --port PORT) [...] telys mcp [--path] # stdio MCP server telys mcp {install | uninstall | status} telys mem {add | search | create | list | stats} ``` ## Global behavior * **Bare `telys` prints help and exits `0`.** * **Exit codes are stable.** `0` success, `1` a defined "not ready" state (for example, the runtime is not installed), `2` usage error or not-yet-implemented command. See [Environment & exit codes](/cli/environment-and-exit-codes.md). * **Configuration comes from the environment.** On-disk state lives under `$TELYS_HOME` (default `~/.telys`). Override the control-plane and download hosts with `$TELYS_ACCOUNTS_URL`, `$TELYS_API_URL`, and `$TELYS_PACKAGES_URL`; the full list is in [Environment & exit codes](/cli/environment-and-exit-codes.md). * **Version.** `telys version` prints the installed distribution version and the on-disk format version. ```bash telys # help, exit 0 telys version # e.g. telys 0.1.0b2 (format v1) ``` {% hint style="info" %} Subcommands that touch a collection (`serve`, `mem`, the MCP server) need the signed runtime installed and activated. Check with `telys runtime status`, install with `telys login`, confirm the signature with `telys runtime verify`. {% endhint %} ## Commands | Command | What it does | Reference | | --------------- | ----------------------------------------------------------------------------------- | -------------------------------- | | `telys login` | Device-code sign-in; caches credentials and (by default) installs the runtime. | [telys login](/cli/login.md) | | `telys version` | Print the installed version and on-disk format version. | [telys version](/cli/version.md) | | `telys runtime` | Check, install, verify, or (stub) update the signed native runtime. | [telys runtime](/cli/runtime.md) | | `telys serve` | Serve a collection path over a Unix socket or TCP for `RemoteTelys`. | [telys serve](/cli/serve.md) | | `telys mcp` | Run the stdio MCP server, or install/uninstall/inspect its client config. | [telys mcp](/cli/mcp.md) | | `telys mem` | Advanced: add, search, create, list, and inspect a local collection from the shell. | [telys mem](/cli/mem.md) | ### telys login Browser device-code sign-in (RFC 8628). Caches credentials under `$TELYS_HOME` and, unless told otherwise, installs the signed runtime. Use `--token` for headless CI. See [telys login](/cli/login.md). ### telys version Prints `telys (format v)` — the installed distribution version (`0.0.0+source` in a source checkout) and the on-disk `FORMAT_VERSION`. See [telys version](/cli/version.md). ### telys runtime Manages the signed native runtime: `status` (`0` ready / `1` not), `install` (offline `--file` or hosted download), and `verify` (offline signature check). `telys runtime update` is a stub that exits `2`. See [telys runtime](/cli/runtime.md). ### telys serve Serves a collection directory over a trusted Unix socket or authenticated TCP for [RemoteTelys](/reference/remote-api.md). Pass `--socket` or both `--host` and `--port`; TCP requires an access token. See [telys serve](/cli/serve.md). ### telys mcp Bare `telys mcp` runs the stdio MCP server. `install` writes launcher config for Claude, Cursor, Codex, or Claude Desktop; `uninstall` and `status` manage it. See [telys mcp](/cli/mcp.md). ### telys mem Advanced, scriptable wrapper over one local collection: `create`, `add`, `search`, `list`, and `stats`. For smoke tests and shell pipelines. See [telys mem](/cli/mem.md). ## See also * [Environment & exit codes](/cli/environment-and-exit-codes.md) — every variable the CLI honors and what each exit code means. * [Install Telys](/start-here/install.md) — get the `telys` command on your machine. * [Sign in & activate a license](/start-here/sign-in.md) — the first command most people run after install. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.telys.ai/cli/overview.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.