Install

The SpiderPublish extension runs in any VSCode-based IDE (VSCode 1.85+, Cursor, Antigravity, VSCodium, Theia, Gitpod). The same .vsix works everywhere.

1. Install the extension

VSCode

VSCode 1.85 or later.

code --install-extension SpiderIQ.spideriq-publish

Or in the editor: Cmd+Shift+X (macOS) / Ctrl+Shift+X (Windows/Linux) → search "SpiderPublish" → click Install.

Cursor

Cursor pulls extensions from the Open VSX Registry.

cursor --install-extension SpiderIQ.spideriq-publish

Or in the editor: open the Extensions panel → search "SpiderPublish" → click Install.

Antigravity

Antigravity uses Open VSX as well.

antigravity --install-extension SpiderIQ.spideriq-publish

Or use the Extensions panel → search "SpiderPublish" → click Install.

From .vsix file

If you've downloaded the .vsix directly (e.g. from a GitHub release):

code --install-extension /path/to/spideriq-publish-0.1.1.vsix
# or
cursor --install-extension /path/to/spideriq-publish-0.1.1.vsix

Or from the Extensions panel → … menu → Install from VSIX…

After install, you should see a new SpiderPublish icon in the Activity Bar (left edge) and a 📁 not signed in entry in the status bar (bottom-right).

---

2. Get an access token

The extension authenticates with a SpiderIQ PAT (Personal Access Token). You request one with the CLI; an admin approves via a confirmation email.

npx @spideriq/cli auth request \
  --email admin@your-company.com \
  --project "Your Project Name"

The CLI prints a fingerprint summary and starts polling. Your admin receives an email with Approve / Deny links. When they click Approve, the CLI hands you the access token (also written to ~/.spideriq/credentials.json).

Multi-brand tip: if your admin manages multiple brands, the CLI's default behavior since @spideriq/cli@0.9.1 requests cross-brand access in one click. No per-project re-approval needed.

You can also generate a token from the dashboard (/dashboard/auth/tokens) if you already have a session there.

---

3. Sign in

Open the command palette (Cmd+Shift+P / Ctrl+Shift+P) and run:

SpiderPublish: Who Am I?

If you have no token yet, the extension prompts you to paste one. If you ran spideriq auth request in step 2, the token is already in ~/.spideriq/credentials.json — the extension picks it up automatically.

You should now see in the status bar:

📁 not bound · ✓ signed in as agent_<id>

---

4. Bind the workspace to a project

The extension is multi-tenant by default. Each folder you open binds to one SpiderIQ project (a tenant) via a spideriq.json file.

SpiderPublish: Select Project…

Pick the project from the list. The extension writes:

{
  "project_id": "cli_xxxxxxxxxxxxxxxx",
  "project_name": "Acme Corp",
  "api_url": "https://spideriq.ai",
  "created_at": "2026-05-06T..."
}

into the workspace root. Commit this file — it's the per-folder tenant binding (Vercel-style convention). Anyone else on the team who clones the repo will be auto-bound to the same project.

Subfolder safety: the extension walks UP from the active editor's file looking for spideriq.json. So an agency can keep fifty clients open in one window — open clients/acme-corp/pages/home.json and the extension knows you're in Acme. Open clients/zenith/pages/about.json and it knows you're in Zenith. No risk of crossing the streams.

---

5. First pull

SpiderPublish: Pull Content

The extension fans out parallel per-type GETs to the API and writes:

your-project/
  ├── spideriq.json          ← binding (committed)
  ├── pages/
  │   ├── home.json
  │   ├── about.json
  │   └── ...
  ├── posts/
  │   └── ...
  ├── components/
  │   └── ...
  ├── templates/
  │   └── ...
  ├── redirects.json
  └── .spideriq/
      └── objects.json       ← registry (gitignored — the .git/index analogue)

The Activity Bar's SpiderPublish view now shows your tenant's content as a tree. Status bar shows:

📁 acme-corp · 0 changed · 0 undeployed · ✓ signed in

You're ready to edit. See the Commands reference for the full workflow.

---

Updating the extension

VSCode auto-updates extensions in the background by default. If you want to force-update:

• VSCode: Cmd+Shift+X → click the Refresh icon → look for SpiderPublish → click Update
• Cursor / Antigravity: same panel, same button

To pin to a specific version (e.g. for testing), download a .vsix from a GitHub release and install via the Install from VSIX… menu.

---

Uninstall

Cmd+Shift+X → SpiderPublish → cog icon → Uninstall.

Local files are unaffected — your pages/, posts/, etc. stay on disk. The spideriq.json binding stays. Reinstalling later picks up where you left off.

To also clean up local state:

rm -rf .spideriq          # registry / baselines
rm -f spideriq.json       # tenant binding (only if you really mean it)
rm -f ~/.spideriq/credentials.json  # global access token

---

Settings reference

The extension exposes four user/workspace settings:

Setting	Default	What it does
spiderpublish.apiUrl	https://spideriq.ai	API base URL. Override only for self-hosted deployments.
spiderpublish.dryRunDefault	true	Send destructive ops with dry_run=true first. Keep this on unless you know what you're doing.
spiderpublish.telemetry	errors-only	off / errors-only / usage.
spiderpublish.schemaRefreshHours	24	How often to re-fetch /content/help, /playbook, /variables. Lower if iterating on schema server-side.

Edit via Cmd+, → search "spiderpublish".