CLI Setup

The Agimon CLI (@agimonai/cms-cli) is a command-line tool to set up and manage Agimon CMS projects.

Install the CLI

You can install the Agimon CLI globally to use it across projects:

npm install -g @agimonai/cms-cli

Alternatively, you can use it directly without installation:

npx @agimonai/cms-cli <command>

Generate Blog Pages

To generate blog pages based on your Agimon CMS configuration:

agimon generate

Options available:

  • -t, --api-key [string]
    - Your Agimon domain API key
  • -f, --force
    - Overwrite existing files if matched
  • -y, --yes
    - Auto confirm all prompts
💡

Tip

If you don't provide the API key through the command line, you will be prompted to enter it interactively.

Configure API Keys

To update API keys for your Agimon configuration:

agimon update api-key

Options available:

  • -s, --stage [string]
    - Stage: development or production
  • -k, --key [string]
    - API key
  • -y, --yes
    - Auto confirm all prompts

Requirements

Before proceeding with the CLI setup, ensure you have:

  • Node.js 18.x or higher installed
  • An active Agimon CMS account with API keys

Framework Support

Currently, the CLI primarily supports:

  • Next.js projects

Support for more frameworks is planned for future releases.

Common Issues

API Key Not Found

If you receive an error about invalid API keys:

  1. Log in to your Agimon dashboard
  2. Navigate to Settings > API Keys
  3. Copy the appropriate API key for your environment
  4. Run 
    agimon update api-key
    to update your configuration

File Already Exists

When generating pages, you may encounter warnings about files that already exist. Use the 

--force
flag to overwrite existing files:

agimon generate --force