1. Apidog CLI
Apidog API
  • Introduction
  • API Versions
  • Authentication
  • Import & Export
    • Import OpenAPI/Swagger Data
      POST
    • Import Postman Collection Data
      POST
    • Export Data in OpenAPI/Swagger Format
      POST
  • Team Access Grants
    • Assign a team role via the external API
      POST
  • Project Access
    • Find Team Projects by Exact Match
      GET
    • Find Accessible Teams by Exact Match
      GET
    • Grant or Invite Project Access
      POST
    • List Available Project Roles for a Team
      GET
  • Organization Teams
    • Create organization team
      POST
  • Apidog CLI
    • Overview
    • Installing Apidog CLI
    • Apidog CLI Commands & Options
    • Use Apidog CLI with an AI Agent
  • Schemas
    • TeamRole
    • ErrorResponse
    • ProjectAccessMode
    • CreateTeamAccessGrantRequest
    • TeamAccessGrant
    • CreateTeamAccessGrantResponse
  1. Apidog CLI

Introduction to Apidog CLI

NPM Version
Apidog CLI is a command-line tool designed to let AI Agents call core Apidog capabilities from outside the app, and to integrate Apidog workflows into CI/CD pipelines.
For broader coverage of the Apidog CLI and its use cases in different scenarios, you can refer to the Apidog CLI page on the official Apidog Documentation.
It is optimized to work with AI Agents such as Cursor, Claude Code, Trae, Codex, and other agentic development tools. It is also extensible enough to fit into your continuous integration (CI) servers and build systems.
Apidog CLI stays aligned with Apidog in-app capabilities, so you can manage API documentation, data schemas, mocks, environments and variables, API test cases, test scenarios, test suites, test reports, imports/exports, and branch collaboration from the command line.
The Apidog CLI package is shared across regions. If your project is hosted in Apidog Europe, specify the EU API base URL with --api-base-url https://api.eu.apidog.com when running commands.

Getting Started#

First, install Node.js and Apidog CLI. After installation, you can start using the CLI to manage project resources, run test scenarios, or integrate Apidog into AI Agent and CI workflows. Learn more:
Installing Apidog CLI
Use Apidog CLI with an AI Agent

Integrated Features & Options#

Apidog CLI provides a broad set of commands and options for customizing your workflows. It supports project and team management, API documentation, data schemas, mocks, environments and variables, API test cases, test scenarios, test suites, test reports, imports/exports, and branch collaboration.
See Apidog CLI Commands & Options for more information.
Modified at 2026-09-03 04:19:11
Previous
Create organization team
Next
Installing Apidog CLI
Built with