Preview installation guide

Install Riveted 0.1.0-preview.2.

A fresh installation for Codex Desktop on macOS, with human or agent assistance.

Before you begin

You’ll need a local Node.js runtime. This preview is tested with Node.js 24 and Codex Desktop on macOS.

Registration requires the Codex CLI used with Desktop to be available as codex. Git, pnpm and development dependency installation are not needed.

Read the working preview license and third-party notices. These are the exact documents included in the ZIP.

1. Download, verify and extract

When access is available, sign in through the download page using email or GitHub and save riveted-0.1.0-preview.2.zip. In Terminal, change to its download folder and run:

shasum -a 256 riveted-0.1.0-preview.2.zip
wc -c < riveted-0.1.0-preview.2.zip

Expected size: 2,167,460 bytes. Expected SHA-256:

51a51d9287b41cd37efa42ff554d4f7939740eb7ccd64887cc52b1d42e5f9421

A matching checksum detects changed bytes; it does not authenticate the publisher. Compare against release details obtained from the approved distribution source. Stop on any mismatch.

Extract into a new stable user-owned location outside customer work, development checkouts and the host-managed cache. Keep the complete riveted-0.1.0-preview.2 folder together, including its hidden .agents/plugins/marketplace.json, release-info.json, INSTALL.md and plugin/.

2. Check for conflicts

node --version
codex plugin marketplace list
codex plugin list --json

If the riveted catalog points elsewhere, or Riveted is installed from another catalog such as riveted-local, stop and choose how to resolve that association before proceeding. Preserve the existing installation and unrelated settings. Do not leave duplicate Riveted copies active.

This guide covers a fresh installation. No upgrade or downgrade path is advertised for this first preview.

3. Register and enable

In Terminal, change into the extracted riveted-0.1.0-preview.2 folder, then run:

codex plugin marketplace add "$PWD"
codex plugin add riveted@riveted --json
codex plugin list --marketplace riveted --json

Confirm Riveted is installed and enabled. In Desktop’s plugin settings, enable Riveted if needed. Complete any host permission prompts before continuing.

4. Restart Codex Desktop and start using Riveted

Quit Codex Desktop completely with Command + Q, then reopen it to load the installed plugin. Open the folder where you want to keep your Riveted work and start a new local chat.

Type $Riveted and select Riveted Setup labeled From Riveted. Tell Riveted about your company and products, or provide a product overview. It will guide you through choosing where to save your work and setting up the company context it uses in customer engagements.

Keep your company context and customer engagement files separate from the extracted plugin folder. When you’re ready to work with a customer, choose Riveted Engagement and describe the engagement you want to start.

Ask an agent to help

Copy the prompt below into a local Codex chat and provide the path to your downloaded ZIP. The agent can help install it; you complete any permission prompts, enable the plugin and restart Codex Desktop.

Help me install Riveted 0.1.0-preview.2 from my downloaded ZIP. Ask me for its file path.

Verify the archive before extracting:
Filename: riveted-0.1.0-preview.2.zip
Size: 2167460 bytes
SHA-256: 51a51d9287b41cd37efa42ff554d4f7939740eb7ccd64887cc52b1d42e5f9421

Read the packaged INSTALL.md for prerequisites and installation instructions. Check that Node.js 24 and the Codex CLI are available; ask me to install missing prerequisites before continuing. Extract the complete package, including the hidden .agents folder, to a permanent location outside my customer work and the plugin cache.

Check existing plugins and marketplaces first. If Riveted is already installed or its marketplace points elsewhere, stop and explain the conflict. Preserve unrelated settings and do not enable duplicate copies.

From the extracted package folder, run:
codex plugin marketplace add "$PWD"
codex plugin add riveted@riveted --json
codex plugin list --marketplace riveted --json

Confirm the installation, explain any permissions or enabling I need to complete, and remind me to fully quit and reopen Codex Desktop.

Help and safe removal

Incomplete or corrupt download: stop before extraction or registration. Download a new copy through the website and verify both size and checksum again. Every retry checks sign-in.

Missing Node or Codex CLI: stop before registration. Install Node.js 24 from Node.js, or make the Codex CLI used with Desktop available, then repeat the prerequisite checks.

Existing Riveted association: retain the working copy and ask for an explicit resolution. Do not edit the host cache as maintained source or overwrite unrelated configuration.

Saved-file incompatibility: follow the local plugin’s guidance and leave files unchanged. The website does not inspect or migrate saved work.

To remove this fresh installation, close active Riveted work and run:

codex plugin remove riveted@riveted --json
codex plugin marketplace remove riveted --json

Restart Codex Desktop. After removal succeeds, you can delete the extracted riveted-0.1.0-preview.2 folder. Keep company context, customer folders and engagement files. If removal fails, retain the extracted folder and user files while resolving it.

For help, contact support@relevant.app. Preview assistance is voluntary; no response time or future compatibility is promised. Share the release, host version and error description; keep credentials and confidential customer material out of support messages.

See license and privacy information and the official plugin documentation.