> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gooseworks.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI

> Install the GooseWorks skill catalog into your coding agent — and optionally register the MCP server in the same command.

The GooseWorks CLI installs the **GooseWorks skill catalog** into your coding agent (Claude Code, Cursor, Codex). A master skill file teaches your agent how to search and run 100+ ready-made skills — Reddit / X / LinkedIn scraping, email finding, prospect enrichment, competitor research, and more. Each skill run is credit-billed.

> **CLI vs MCP.** The CLI and the [GooseWorks MCP server](/concepts/mcp-servers) are **two different things**. The CLI is about the skill catalog. The MCP is about your files, chat history, and automations. You can install either one, or both — `npx gooseworks install --mcp` (or `--all`) installs the skill **and** registers the MCP server in the same step as a convenience.

## Install

```bash theme={null}
npx gooseworks install --claude
```

By default, this command installs **only the GooseWorks skill** into your coding agent. The skill teaches your agent how to search the catalog and run any of the 100+ data skills on demand.

If you also want to register the **GooseWorks MCP server**, pass the flag explicitly — see [Install flags](#install-flags) below.

What a default install does:

1. Opens your browser to sign in with Google
2. Installs the GooseWorks skill to `~/.agents/skills/gooseworks/`
3. Symlinks / references it so your coding agent can discover it
4. Saves your credentials to `~/.gooseworks/credentials.json`

## Install flags

The CLI exposes one MCP server you can opt into:

| Flag    | What it registers                                                                                                                                                                                        | Transport                               |
| ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- |
| `--mcp` | **GooseWorks MCP** — file operations (read / write / list / search / upload / delete), chat history (search sessions, fetch transcripts), and automations (create / update / enable / schedule / delete) | HTTP at `https://mcp.gooseworks.ai/mcp` |

Combine it with any agent flag:

```bash theme={null}
# Skill only
npx gooseworks install --cursor
npx gooseworks install --claude
npx gooseworks install --codex

# Skill + MCP
npx gooseworks install --cursor --mcp

# Everything (skill + MCP, across every detected agent)
npx gooseworks install --all
```

`--all` implies `--mcp`, and runs across every coding agent detected on your machine.

> **Codex is skill-only.** The `--mcp` flag applies to Claude Code and Cursor. Passing `--codex --mcp` will install the skill into Codex and silently skip MCP registration there.

See [MCP Servers](/concepts/mcp-servers) for what each MCP provides.

## What happens after install

Your coding agent gets a new skill that teaches it how to use the full GooseWorks toolkit. When you ask it to do any data task — scraping, research, lead generation, enrichment — it will automatically search the GooseWorks skill catalog, fetch the right skill, and run it.

If you registered the MCP server (via `--mcp` or `--all`), the agent also gets direct tool access — files, chat history, and automations — without having to invoke a skill first.

**Example prompts you can try:**

* "Scrape the top posts from r/ClaudeAI on Reddit"
* "Find the email address for the CEO of Acme Corp"
* "Research competitors of Linear.app"
* "List the files in my agent workspace" *(requires `--mcp`)*
* "What did my agent and I talk about last week?" *(requires `--mcp`)*
* "Create a daily automation at 9am that pulls new Linear issues into my workspace" *(requires `--mcp`)*

## Commands

| Command                           | What it does                                    |
| --------------------------------- | ----------------------------------------------- |
| `npx gooseworks install --claude` | Sign in and install the skill into Claude Code  |
| `npx gooseworks install --cursor` | Sign in and install the skill into Cursor       |
| `npx gooseworks install --codex`  | Sign in and install the skill into Codex        |
| `npx gooseworks install --all`    | Install skill + MCP across every detected agent |
| `npx gooseworks update`           | Update to the latest skill version              |
| `npx gooseworks credits`          | Check your credit balance                       |
| `npx gooseworks search "query"`   | Search the skill catalog                        |
| `npx gooseworks logout`           | Sign out and clear credentials                  |

## How skills run

When your coding agent uses a GooseWorks skill:

1. It searches the skill catalog to find the right skill for your task
2. It downloads the skill's instructions and scripts
3. It saves scripts to a temporary directory (never your project folder)
4. It runs the scripts with the right parameters
5. API calls go through GooseWorks proxy — you never need to manage API keys

## Credits

Each skill run costs credits. You start with 200 free credits when you sign up.

Check your balance anytime:

```bash theme={null}
npx gooseworks credits
```

You can top up credits from the [Settings page](https://app.gooseworks.ai/settings?tab=billing) in the web dashboard.

## Credentials

Your login credentials are stored at `~/.gooseworks/credentials.json`. This file contains your API key, email, the API base URL, and (if the backend provides it) `mcp_server_url` for the GooseWorks MCP server.

To switch accounts or environments, log out and log back in:

```bash theme={null}
npx gooseworks logout
npx gooseworks install --claude
```