Skip to main content

​
Overview

Follow installation, login, and your first chat. These four steps prepare you to send requests from your terminal.

​
Prerequisites

Prepare these two things before installing:
  • Node.js 20 or later
  • An active NoimosAI account (sign up)

​
Set up the CLI

Complete these four steps.

​
1. Install the CLI

Install @noimosai/cli globally using your package manager.
For npm, run the following command.
After installation, check that the version is displayed.

​
2. Sign in to NoimosAI

Run this command to choose an authentication method interactively.
Two methods are available:
  • Browser login (OAuth) — Sign in through your browser. Suitable for your local terminal.
  • API key — Use a key issued in the API tab of NoimosAI team settings. Suitable for environments without a browser, such as CI/CD.
To specify the authentication method directly, use these commands.
Passing a key directly with --api-key <key> can expose it to other processes on the same computer. Use --api-key-stdin in non-interactive environments.
This key is for regular NoimosAI workspaces. Developer Platform keys beginning with nmp_ cannot be used here.

​
3. Start your first chat

After signing in, start an interactive session.
Ask the NoimosAI agent questions, request marketing deliverables, or refine generated content through conversation. For a single request, specify the prompt with -p.

​
4. Check available commands

Display commands and options available in your installed version.
See Check commands for an overview of commands in the published release.

​
Troubleshoot connection issues

Check the following according to the error shown:
  • Not authenticated — Run noimosai login again.
  • Workspace ID not configured — Select a workspace during login or pass -w <workspace-id> to a supported command.
  • Missing command or option — Reinstall the latest published release and check noimosai --version and noimosai <command> --help.
  • Cannot publish a JSON file — Use noimosai post posts.json --now --dry-run to inspect the destination, text, and media paths.
Run noimosai logout to remove saved credentials before signing in again. See these pages for commands and other connection methods.