Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

CLI introduction

Prev Next

Available in Classic and VPC

We provide Command Line Interface (CLI) to help you effectively manage the services and solutions provided by NAVER Cloud Platform. After installing and configuring development tools on Linux and Windows, you can control various services of NAVER Cloud Platform from the command line and develop scripts to automate them.

CLI type

The NAVER Cloud Platform CLIs are broadly categorized into the basic CLI and the compatible CLI.

  • Basic CLI (Ncloud CLI): A CLI that allows you to manage NAVER Cloud Platform services. This refers to all CLIs except for the compatible CLIs.
  • Compatible CLI: A NAVER Cloud Platform CLI that is compatible with third-party service CLIs.
    • Compatible with AWS S3: Ncloud Storage CLI, Object Storage CLI
    • Compatible with OpenStack Swift: Archive Storage CLI

CLI guide information

The CLI guide consists of the following topics to help you effectively use various CLIs of NAVER Cloud Platform. To ensure a seamless experience with the CLI guide, review the following table of contents and the content under each section.

  • CLI overview: CLI guide and common information, CLI classification-specific introduction, request and response data type information guide
    • CLI introduction: CLI types, related resources helpful for the use, and FAQ
    • Download CLI: Guide to installing the Ncloud CLI and setting up API authentication key
    • CLI authentication: Guide to Ncloud CLI command structure, parameters, and output formats
    • Using CLI: Scenarios for running the CLI in VPC and Classic environments
  • Big Data & Analytics: Introduction to Big Data & Analytics's service-specific commands and instructions on how to use them
  • Compute: Introduction to Compute's service-specific commands and instructions on how to use them
  • Database: Introduction to Database's service-specific commands and instructions on how to use them
  • Networking: Introduction to Networking's service-specific commands and instructions on how to use them
  • Storage: Introduction to Storage's service-specific commands and instructions on how to use them

CLI guide related resources

NAVER Cloud Platform provides a variety of related resources as well as guides to help users better understand CLI. The related resources of CLI are as follows:

  • User Guides: User guide for each service of NAVER Cloud Platform
  • API Guides: API guide for each service of NAVER Cloud Platform
  • FAQs: Get answers to common CLI questions.
  • Contact Support: Get help if you can't find what you need in the CLI guide.

API FAQs

Before reading the CLI guide, you can quickly resolve your questions by reading the answers to frequently asked questions. If you haven't found the answer to your question in the FAQs below, then search the API guide for what you would like to know.

Q. Where can I find the API authentication key required to use the CLI?
A. For more information on how to check the API authentication key, see API authentication key.