Skip to content
Tylor guide

Connect your agent

Tylor uses the same CLI and skill with Codex, Claude Code, Pi, OpenCode, and other agents that can run terminal commands and read skill instructions. You need a signed-in Tylor account and Node.js 18 or newer in the environment where the agent runs.

1. Install the CLI

Section titled “1. Install the CLI”
Terminal window
npm install -g tylor-cli@latest
tylor --help

The package is named tylor-cli; its command is tylor. Use the current CLI with a current Tylor backend, especially when an agent and a person edit the same project.

2. Install the skill for your agent

Section titled “2. Install the skill for your agent”

Choose the agent you use. These commands install the same tylor/SKILL.md into its local, user-level skills directory. Paths below use macOS/Linux shell syntax; use the corresponding home-directory path in your environment.

Install for CodexIllustrative session
tylor skill install ~/.agents/skills
installed the Tylor skill → /home/you/.agents/skills/tylor/SKILL.md

Sample output. Commands are not executed on this page.

Codex skill locations include ~/.agents/skills. If the skill does not appear, restart Codex. Older Tylor instructions used ~/.codex/skills; use the location supported by your installation and avoid duplicate enabled copies.

The previews show an excerpt of the installer output. Install only where needed, and refresh or restart the agent if the skill is not detected.

3. Connect your Tylor account

Section titled “3. Connect your Tylor account”

In Tylor, open Account → API keys, create a key with a recognizable name such as Document agent, and copy it when shown. Keep the key out of prompts, documents, screenshots, and Git.

The CLI reads TYLOR_API_KEY from its environment or apiKey from ~/.config/tylor/config.json. A local configuration file is useful when a desktop agent does not inherit your terminal environment.

Create the directory:

Terminal window
mkdir -p ~/.config/tylor

Use a local text editor to save this file, replacing the placeholder privately:

{
  "apiKey": "PASTE_YOUR_TYLOR_API_KEY_HERE"
}

Restrict access to it on macOS or Linux:

Terminal window
chmod 600 ~/.config/tylor/config.json

If the configuration file already exists, add or update only apiKey and preserve its other settings. The default API endpoint is https://api.tylor.app; for another instance, set TYLOR_API_URL in the environment where the CLI runs.

The key grants your account’s access, not access to a single document. Revoke it from Tylor when no longer needed. For remote or container-based agents, configure the CLI and credentials in that execution environment too; installing them on your laptop does not configure a remote session.

4. Verify from your agent

Section titled “4. Verify from your agent”

First run tylor list in your terminal. Then ask your agent:

Use the Tylor skill to list my projects. Do not change anything.

Confirm that it finds the intended workspace. You can then give it a project name or ID and a task. See work with your agent for a terminal walkthrough.

Symptom Check
tylor not found Node and the global npm executable directory must be available to the agent, not only your interactive terminal
Skill not found Check the installed tylor/SKILL.md path and refresh or restart the agent
No API key Configure the key in the same machine/user environment where the command runs
Unauthorized or forbidden Check the key, account status, project access, and API endpoint
Network or permission error Allow the required CLI execution and API access in your agent environment
A project is missing Check the account; browser-only local projects are not available through the API

Update the CLI and skill together

Section titled “Update the CLI and skill together”

Run npm install -g tylor-cli@latest, then repeat the skill-install command for your agent above. The installer replaces that copy of the Tylor skill. Keep personal workflow instructions in a separate skill so an update does not overwrite them.