@carto/carto-cli
v0.9.2
Published
The CARTO CLI enables humans and agents to completely operate CARTO from their terminal, including creation and management of maps, workflows, connections, users, credentials, and more.
Readme
CARTO CLI
The CARTO CLI enables humans and agents to completely operate CARTO from their terminal, including creation and management of maps, workflows, connections, users, credentials, and more.
Installation
npm install -g @carto/carto-cliOptional: SQL Querying of Activity Data
For the carto activity query command, install DuckDB separately:
# If you installed the CLI globally:
npm install -g @duckdb/node-api
# Or, if you're using the CLI inside a local project:
npm install @duckdb/node-apiUses prebuilt binaries, no compilation required.
CARTO Platform version support
The CARTO CLI is designed to work seamlessly with CARTO Self-hosted platform deployments. However, newer versions of the CLI might not be compatible with older versions of CARTO Self-hosted deployments, due to missing API functionalities.
For a full compatibility list, check the CARTO Self-hosted release notes
Latest version of the CARTO CLI will always work with the up-to-date version of the CARTO SaaS platform.
Documentation
For details on how to use the CARTO CLI, including the complete command reference, check out our documentation
Usage Examples
# 1. Log in to CARTO (opens browser)
carto auth login
# 2. List your maps
carto maps list# Import a local file into your data warehouse
carto imports create \
--file ./data.csv \
--connection carto_dw \
--destination project.dataset.my_tableLicense
Proprietary - See LICENSE for details.
This software requires a valid CARTO account. Usage is subject to CARTO's Terms of Service.
