# Operlyx Links agent setup

The [`operlyx-links` skill](https://link.operlyx.com/skills/operlyx-links)
teaches compatible coding agents to manage short links, download QR assets, and
read reports or usage through the Operlyx Links Public API.

## Before installation

1. Copy the installation prompt below to your agent.
2. Let the agent inspect and install the versioned bundle.
3. Follow its instructions to create a least-privilege API key and expose it as
   `OPERLYX_API_KEY` without pasting the value into chat.

## Installation prompt

Copy this text to your coding agent:

```text
Install the Operlyx Links skill from its official release page:
https://link.operlyx.com/skills/operlyx-links

Read the release manifest, download the current versioned ZIP, verify its
SHA-256 checksum, and inspect the bundled SKILL.md before installing it in the
appropriate user-level skill directory for this agent. Do not overwrite an
existing operlyx-links skill without asking me first.

After installation, verify that the skill is discoverable. Then guide me
through first-time setup: confirm that my plan includes Public API access,
show me where to create a 90-day API key with the default agent scopes, and
explain how to expose it as OPERLYX_API_KEY without asking me to paste the key
into chat or writing it into the repository.

Once I confirm the environment variable is available, use the installed skill
to run read-only workspace and usage preflights. Show the workspace name, plan,
granted scopes, key expiry, and remaining link quota. Do not create, update,
disable, retire, or download anything until I give a separate explicit request.

Finish by giving me three short example requests I can make next: create a
link, download its SVG QR code, and read a date-bounded report.
```

## First-use prompt

After installation and credential setup:

```text
Use $operlyx-links to create a short link for https://example.com,
then download its SVG QR code.
```

The agent should ask for a destination path before saving a QR file and must ask
for explicit confirmation before retiring a link. Retirement permanently
tombstones the slug.

## API contract

The live [OpenAPI specification](https://link.operlyx.com/openapi.yaml) is the
source of truth for endpoints, schemas, authentication, and stable error codes.