PortOne CLI

English | 한국어

portone brings PortOne to the terminal. Search and cancel payments, manage webhooks, and call the PortOne V2 API from the command line.

Supports macOS, Windows, and Linux.

Installation

npm install --global @portone/cli

Requires Node.js 22.18.0 or later in the 22.x line, or Node.js 24 or later.

Quick start

Log in through PortOne Console, then inspect payments:

portone auth login
portone payment list --test --status failed
portone payment view --payment-id payment-xxx

Replace payment-xxx with the paymentId set when making the payment. Use portone <command> --help for options and examples.

Documentation

• Command reference
• Usage examples: payments, API requests, and shell completion
• Configuration: authentication, profiles, stores, and language

Agent skills

Install PortOne skills and MCP settings for your coding agent:

portone setup

# Install for a specific agent and scope
portone setup --agent codex --scope user

# Update installed skills and MCP settings
portone setup update

Supports Claude Code, Codex, Cursor, Gemini CLI, GitHub Copilot CLI, VS Code Copilot, and OpenCode. See the setup guide for options and installation paths.

Contributing

See the development guide to build from source and update documentation. Report bugs and request features in GitHub Issues.