Agent Setup

Install Explore for external agent use.

This guide shows the shipped path for using Explore outside the Rails repo: install the packaged CLI, install the Explore skill, set the right environment, and start with a public-safe profile inspect.

Open Agents Guide Open API Guide

You need

  • A reachable Explore base URL
  • The packaged explore CLI on your PATH
  • The Explore skill folder installed into your Codex skills directory

Sample public target: /profiles/johnny

Step 1

Install the CLI

Build and install the packaged gem so explore is available globally.

gem build explore.gemspec
gem install --local explore-0.1.0.gem

Step 2

Install the skill

Use Codex's built-in skill installer with the public Explore skill repository.

Use $skill-installer to install:
https://github.com/johnnybutler7/explore-skill

Repo-local fallback: if you already have this app checked out locally, you can still copy skills/explore into $CODEX_HOME/skills/explore.

Step 3

Set environment and auth

Point the CLI at your Explore host. Public slug-scoped reads do not need a key. Owner-only commands still need the shared app key or a signed-in session.

export EXPLORE_BASE_URL=http://localhost:3000

# Public-safe read
explore profile inspect --slug johnny --json

# Owner-only flow
export EXPLORE_API_KEY=your-shared-explore-api-key
explore drafts list --account acme-careers --json

Auth boundary

Know when a key is required

  • explore profile inspect --slug ... and explore content list --slug ... are public-safe and do not need EXPLORE_API_KEY.
  • explore drafts *, onboarding status, manifest next-actions, notion sync-status, publish preview, content create-draft, and content propose-update are owner-only.
  • The current owner token model uses the shared app-level key from Rails credentials at api.v1_key.

First run

Try the shipped path end to end

explore profile inspect --slug johnny --json
explore content list --slug johnny --json
EXPLORE_API_KEY=your-shared-explore-api-key explore drafts list --account johnny --json

Repo-local fallback: if you are already inside this app checkout, bin/explore wraps the same CLI for local development.