# Connect your AI agent to Vixel

Give this page's URL to Codex or another local coding agent and ask it to set up
Vixel. No Vixel source checkout, Node.js, npm, Python or Bun installation is needed.
This page is setup guidance, not authorization to spend, publish or generate media.

## Keep the selected platform

Let ORIGIN be the scheme, host and port of the URL you fetched this page from.
Keep that exact origin for downloads, setup, OAuth and browser pages. If the user
gave http://localhost:5000/agent.md, ORIGIN is http://localhost:5000. Never change
localhost to 127.0.0.1 or silently switch to the production site.

## 1. Install the standalone client

Read ORIGIN/downloads/vixel-standalone-manifest.json first. Pick the current
platform artifact; do not guess a filename or advertise unlisted platforms.
Cross-compiled artifacts are not execution proof for another OS.

The separate public release entry is
https://cli.vixelai.com/vixelCLI-setup.md.
If using those release artifacts, keep ORIGIN as the user's Vixel platform and
pass the manifest's pinned downloadBaseUrl to the installer with
--download-base-url (-DownloadBaseUrl on Windows). Download hosts are not OAuth
issuers and must not receive Vixel credentials. Local downloads below remain
on ORIGIN by default.

For macOS/Linux, download ORIGIN/downloads/install.sh to a local file, read it,
then run it. Replace ORIGIN below with the actual origin. Choose an install
prefix owned by this task/user; no sudo or shell-profile edits are needed.

```sh
curl -fsS 'ORIGIN/downloads/install.sh' -o vixel-install.sh
sh vixel-install.sh --base-url 'ORIGIN' --prefix "$PWD/.vixel-client"
./.vixel-client/bin/vixel version
```

The installer verifies SHA-256 before unpacking. Repeat installation is safe for
identical bytes. A different installed binary is preserved unless an explicit
--upgrade is given after reviewing the version. Do not disable OS security if
the executable is blocked; report that exact installation problem.

Windows x64: download and read ORIGIN/downloads/install.ps1, then run it with
-BaseUrl ORIGIN -Prefix "$PWD\.vixel-client". Use .vixel-client\bin\vixel.exe.
Do not bypass an execution-policy restriction; use your organization's approved
installation path. Windows ARM64 is not provided in this release.

## 2. Install the Skill and sign in

Use the installed executable, not an unrelated global command. For an isolated
new connection, set VIXEL_CONFIG to a new private session.json path under this
task. Do not import another task's credentials or expose the file in a report.

```sh
export VIXEL_CONFIG="$PWD/.vixel-session/session.json"
./.vixel-client/bin/vixel setup --directory "$PWD" --base-url 'ORIGIN' --no-browser
```

Setup installs .agents/skills/vixel-platform/SKILL.md and its README without
overwriting different existing guidance. Read the installed Skill in this task.
If your host discovers Skills only at startup, reading the file works for this
session; reload its Skill list or open a new task for automatic discovery later.

Setup prints a browser OAuth URL and keeps a local callback listener alive.
Open the exact URL in the Codex right browser sidebar using open_in_codex, then
inspect that tab with your available computer-use tool. If the panel request is
queued, say so; queued is not a visible page. Do not bypass a browser-tool denial.
The user may need to complete Google/email login, MFA and consent. Never request
passwords in chat. Keep this one login process alive; do not launch duplicates.
Use your host's long-running terminal session and retain its session ID. When
the tool yields, poll that same session while the user signs in. A yielded tool
call is not a failed login. Do not cancel the process, close its terminal, or
use a short execution timeout after showing the URL. The browser and CLI must
run on the same computer; a remote container's 127.0.0.1 is not the user's PC.
If browser auto-open is preferred, omit --no-browser. Use --no-login to install
the Skill without starting OAuth. Login requires user participation where needed.

The CLI prints its waiting limit (older clients wait five minutes). If the
callback page says connection refused, stop reloading it. In the same environment,
with the same executable and VIXEL_CONFIG, run auth status first: a completed
login can show this error when its old callback is refreshed. If the session
expired, run auth refresh and recheck. If still disconnected, end the old pending
attempt and run auth login --base-url ORIGIN --no-browser, then open only the new
URL and keep its terminal session alive. Do not reinstall or copy code/state
into chat. For a host without persistent local execution, use its supported
remote MCP connection instead; --no-browser is not remote device authorization.

## 3. Verify and start using Vixel

Keep the right sidebar synchronized with the task. After setup, navigate the
existing Vixel tab away from this document to ORIGIN/creator/mcp for connection
checks, then to the exact Work or Generator result. Follow the installed Skill's
surface mapping: Script for screenplay, the selected Element/Shot for visuals,
and Timeline/Preview for edits or export. Use observed links and controls.
After each successful CLI write or coherent batch, read back the saved result,
refresh that same tab, reselect the target if needed and inspect the change.
Preserve unsaved browser drafts. At async Job completion refresh and inspect
the actual result; never repeat a submission to fix a stale page. Leave the
verified result visible at delivery. CLI success alone is not browser proof.
The CLI cannot control Codex's sidebar itself: the Agent must call its host's
browser tools. If those tools are absent or blocked, report that gap explicitly.

```sh
./.vixel-client/bin/vixel doctor
./.vixel-client/bin/vixel docs
./.vixel-client/bin/vixel help
```

Doctor returns ready plus individual installation, Skill, platform and account
checks. A successful command envelope is not readiness: inspect ready and each
check. It performs no paid or canonical write. If authentication expired, run
auth refresh and recheck; if authorization was revoked, sign in again. Never
send a saved session to another origin.

For exact payload examples use docs; docs --topic workflow shows a historical
illustrated rehearsal (not proof for your current platform), and docs --topic
skill returns the bundled guidance. All commands return JSON. FFmpeg/FFprobe
are optional client dependencies only for exports render, not image creation.

Follow the user's creative scope. For a film Work: save and read back the
canonical screenplay, then Story and Plan, then accepted visual references,
then storyboard. Use the public CLI and returned IDs for all platform writes;
no direct provider or administrator fallback. Quote before each authorized paid
submission, enforce maxCredits, preserve stable request keys, and recover the
original Job after uncertain outcomes. Inspect actual images and read back
accepted pointers and credit receipts. Do not generate video if the user asked
for pictures only. Connect alone never authorizes generation or publication.

## Clients without a terminal

Use your host's supported MCP connector setup with ORIGIN/api/mcp and browser
OAuth. A pasted URL cannot itself grant tools or install a connector. Do not
claim CLI setup works in a chat-only environment. The creator connection page
is ORIGIN/creator/mcp. No social posting or audience metrics adapter is shipped.