mcpField
O
obelisk-installer

obelisk-installer

github.com/tommy0103Agent workflows698100 installsUpdated 1w ago
Repository

About obelisk-installer

obelisk-installer is a setup guide for installing the Obelisk CLI and official agent skill. It is for users bootstrapping Obelisk, and calls for approval of global CLI installation and a choice between project-level and global skill scope.

Key features

  1. 01Check whether the Obelisk CLI is installed
  2. 02Provide official CLI installation methods
  3. 03Choose project or global skill scope
  4. 04Follow the skills installer prompts

Use cases

  1. 01Set up Obelisk for the first time
  2. 02Install /obelisk in the current project
  3. 03Make /obelisk available across projects

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/tommy0103/obelisk --skill obelisk-installer

After installing, type/obelisk-installerin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

.gitignore
AGENTS.md
CONTEXT.md
LICENSE
CONTRIBUTING.md
PRODUCT.md
README.md
.github/
pull_request_template.md
.github/scripts/
verify-deb-runtime.mjs
.github/workflows/
build-deb.yml
publish-dsh-plugin.yml
publish-skill.yml
cli.yml
release-app.yml
app/
package.json
electron-vite.schema-plugin.mjs
electron.vite.config.ts
app/build/
sparkle-public-key.txt
icon.icns
app/scripts/
sparkle-packaging.mjs
update-release.mjs
app/src/main/
index.ts
indexer-worker-client.ts
indexer-service.ts
indexer-worker.ts
file-reference.ts
indexer.ts
quit-teardown.ts
update-backends.ts
recap-capture-query.ts

Details

From the project README

Install Obelisk

This is a one-time bootstrap guide. It installs the local Obelisk runtime, then uses that runtime to install the official agent skill from github.com/tommy0103/obelisk-skill.

1. Check for the CLI

command -v obelisk >/dev/null 2>&1 && obelisk --version

If this succeeds, skip to step 3. Do not reinstall a working CLI unless the user asked to upgrade or repair it.

2. Install the CLI

Installing a global command changes the user's machine. Show the command and get the user's approval before running one of these official installation methods.

With npm:

npm install --global @obelisk-apps/cli

On macOS, Linux, or WSL, the official installer performs the same CLI-only installation and never installs an agent skill:

curl -fsSL https://raw.githubusercontent.com/tommy0103/obelisk/main/install.sh | sh

Never use sudo, install a daemon, or download Obelisk from another source.

Verify the result:

obelisk --version

3. Choose the skill installation scope

The standard skills installer defaults to the current project. Before running it, tell the user about that default and ask whether /obelisk should be installed:

  • For the current project only — available only in the project where the installer runs.
  • Globally — available across the user's projects.

Do not silently choose the current-project default. If the user already stated the scope explicitly, use that choice without asking again.

Run the command that matches the user's answer:

Current project:

obelisk install

Global:

obelisk install --global

Pass through any additional target options the user requested. The command uses the standard skills installer, so follow its prompts instead of copying skill files by hand.

After installation, tell the user to reload their agent if the new /obelisk skill is not discovered immediately. This bootstrap document is not the query skill and must not answer session-history questions itself.

Comments

Markdown supported