Metorial CLI is the command line interface for Metorial. This CLI is built agent-first, meaning it is designed to be used both by developers directly and by agents that need to interact with Metorial resources and integrations.
Choose the install method that matches how you normally manage tools.
Best if you already use Node.js and want metorial available globally.
npm install -g @metorial/cliBest for one-off usage or quick checks without a global install.
npx @metorial/cli@latestBest on macOS and Linux if you want the standalone CLI without depending on Node.js.
curl -fsSL https://cli.metorial.com/install.sh | bashBest if you already manage command line tools with Homebrew.
brew install metorial/tap/metorialBest for Windows setups that already use Chocolatey.
choco install metorialBest for Windows setups that prefer Scoop.
scoop bucket add metorial https://github.com/metorial/scoop-bucket
scoop install metorialIf you want to browse or create an official example project first:
npm create metorial@latest
npm create metorial@latest <identifier> [path]- Use
npmif you want a standard global install in a Node.js environment. - Use
npxif you only need the CLI occasionally. - Use the bash installer if you want a simple standalone install on macOS or Linux.
- Use
brew,choco, orscoopif you already manage tools through that package manager. - Use
npm create metorial@latestif your main goal is to begin with an official sample project.
Install the CLI, then start here:
metorial login
metorial providers list
metorial deployments list
metorial sessions list
metorial integrations list
metorial example listIf you want the dashboard as well:
metorial openMetorial organizes work by organization, then project, then instance. In practice, an instance is usually the environment you are working against, such as development or production.
When you browse resources in the CLI, you are usually looking at resources available in the current authenticated context and selected instance.
Providers are the integrations you connect to Metorial. They define the tools, authentication methods, and configuration options available for a given integration.
The CLI lets you inspect providers and related resources directly:
metorial providers list
metorial providers get <provider-id>Deployments are the configured, ready-to-use instances of your providers. They are the core building blocks your applications use.
Common commands:
metorial deployments list
metorial deployments get <deployment-id>Sessions are the runtime layer that connects your application to one or more providers. A session exposes the tools from the attached providers and is useful for testing, debugging, and understanding how your runtime setup behaves.
Common commands:
metorial sessions list
metorial sessions get <session-id>Integrations help you discover, set up, and manage the providers available through Metorial.
Common commands:
metorial integrations list
metorial integrations catalog list
metorial integrations get <integration-id>metorial loginStarts the sign-in flow and saves your profile locally so the CLI can act on your behalf.
metorial providers list
metorial deployments list
metorial sessions list
metorial instance listThis is the fastest way to understand what is available in your account and environment.
metorial integrations list
metorial integrations catalog list
metorial integrations tools <integration-id>Use these commands to review connected integrations, browse the catalog, and inspect the tools exposed by an integration.
metorial example list
metorial example create <identifier>Use examples when you want a working starting point instead of beginning from scratch.
Examples are also available through npm create.
npm create metorial@latest
npm create metorial@latest <identifier> [path]metorial fetch <path-or-url>Useful when you want to inspect an API response directly from the terminal while keeping the same authenticated context.
Use built-in help to discover commands as you go:
metorial --help
metorial <command> --helpFor a shorter install-first guide, see cli.metorial.com/cli.md in this repository or visit cli.metorial.com.