---
title: "YouSpot CLI"
description: "The official YouSpot command line tool: ask about YouSpot, search the docs, list and call the MCP tools, and chat with your own CRM from a terminal."
canonical: https://youspot.com/docs/cli
last-updated: 2026-09-04
---

# YouSpot CLI

> The official YouSpot command line tool: ask about YouSpot, search the docs, list and call the MCP tools, and chat with your own CRM from a terminal.

The YouSpot CLI is the `youspot` package on npm. It needs Node 18 or newer and has no dependencies. Run it without installing:

```bash
npx youspot ask "what does it cost"
npx youspot docs oauth pkce
npx youspot read /docs/mcp
npx youspot tools
```

## Commands

| Command | What it does | Credential |
| --- | --- | --- |
| `youspot ask <question>` | Answers from YouSpot's own pages, each with the URL it came from | none |
| `youspot docs <query>` | Searches the developer docs over the documentation MCP server | none |
| `youspot read <path>` | One page as markdown, for example `/docs/mcp` or `/pricing` | none |
| `youspot pages` | Every page that can be read | none |
| `youspot tools` | Lists the tools on the product MCP server | none |
| `youspot call <tool> [json]` | Calls one MCP tool on your own account | `YOUSPOT_TOKEN`, else session |
| `youspot index` | Every endpoint, and what each one needs | none |
| `youspot member <username>` | One public member profile | none |
| `youspot directory` | A page of the public member directory | none |
| `youspot signup` | Creates an account and saves the session | none |
| `youspot login` | Signs in through the browser with a one-time code | none |
| `youspot whoami` | The account this terminal is signed in as | session |
| `youspot chat [message]` | Chats with your account, one message or a prompt | session |
| `youspot logout` | Ends the session on the server and deletes it here | session |

`--json` prints the raw response, and `--limit n` applies to `ask`, `docs` and `directory`. Results go to stdout and messages to stderr. The exit code is 0 on success, 1 on a failure and 2 on a usage error.

## Sign in

`youspot login` prints a link and a code, opens the link in your browser and waits until you approve it. `youspot signup` creates an account from the terminal, and every answer can come from a flag so it runs with no terminal at all.

```bash
npx youspot login
npx youspot chat "who do I know at Acme?"
npx youspot call get_connections_summary
```

The session is saved in `${XDG_CONFIG_HOME:-~/.config}/youspot/credentials.json` with mode 0600, and `youspot logout` revokes it. For `youspot call` you can also set `YOUSPOT_TOKEN` to a token minted in your MCP settings, which wins over a saved session. `YOUSPOT_BASE_URL` picks another server.

## Use it as a library

The same package is the JavaScript SDK. See /docs/sdk for it and for the Python, Go and Ruby clients.

```js
import { ask, tools, callTool } from "youspot";

const answer = await ask("how do I connect a client");
const available = await tools();
const summary = await callTool("get_connections_summary", {}, { token });
```

## MCP over stdio

For an MCP client that only speaks stdio, `npx @youspot/mcp` bridges to `https://youspot.com/mcp`. Clients that speak streamable HTTP connect to that URL directly, as /docs/mcp describes.

## Source

The CLI is open source in https://github.com/OnStartups/youspot-agent-tools, with the SDKs and the official agent skills.