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

# TRIGGERcmd plugin

> List registered computers and their commands, run a command remotely, read run history, and press panel buttons.

Use **TRIGGERcmd** through Corsair: one client, typed API calls.

Copy the token from the Instructions page at [https://www.triggercmd.com/user/computer/create](https://www.triggercmd.com/user/computer/create), which is also where a computer is registered. The plugin sends it as a Bearer token.

Things to know:

* **Commands live on your computers.** The cloud only stores their names and settings, so `commands.list` reports what each agent synced. Adding or editing a command happens in the agent's `commands.json`, not through this API.
* **A trigger is not a completion.** `commands.run` acknowledges that the request was dispatched. Use `commands.history` to see whether it actually ran.
* **Parameters need Allow Params.** A command runs without parameters unless the agent's Allow Params flag is on, and an empty `params` string is rejected here because it would pass an empty argument rather than omitting it.
* **Panel buttons belong to the dashboard.** Each button is configured with the command it runs. `panels.trigger` needs the panel and button names; `params` is optional and only matters for a button that takes them.
* **A 404 means the route is wrong.** A real route with a bad token answers 401 with `Invalid Token!`, so a 404 is a path error rather than an auth one.
* **No webhooks.** The provider posts no events for command completion, so poll `commands.history`.

**What you get:**

* 6 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/triggercmd better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/triggercmd better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/triggercmd better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/triggercmd better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { triggercmd } from '@corsair-dev/triggercmd';

export const corsair = createCorsair({
	plugins: [
		triggercmd(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the TRIGGERcmd API key before the first call: `pnpm corsair setup --plugin=triggercmd --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> triggercmd()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'triggercmd',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**List your registered computers**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.triggercmd.api.computers.list({});
```

**Run notepad on the laptop, with a parameter**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.triggercmd.api.commands.run({ computer: 'laptop', trigger: 'notepad', params: 'MyNote' });
```

See the full list on the [API](https://docs.corsair.dev/plugins/triggercmd/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/triggercmd/api.md)
>
> Every `triggercmd.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.