Skip to Content
CLIGetting SupportFAQ

CLI FAQ

Installation and Setup

How do I install CloudQuery CLI?

CloudQuery CLI runs on macOS, Linux, and Windows. See the getting started guide for your platform:

Do I need to authenticate with CloudQuery?

You only need to run cloudquery login if you’re using:

  • Commercial or premium integrations
  • CloudQuery Platform
  • Private integrations from GitHub

Free community integrations don’t require authentication.

Do I need a license for air-gapped or offline environments?

Yes. If you’re using CloudQuery in an air-gapped environment, you’ll need an offline license for commercial integrations. Contact our sales team to obtain an offline license file.

Configuration

How do I configure a sync?

Syncs are defined in YAML configuration files. Each file specifies a source integration (where data comes from), a destination integration (where data goes), and which tables to sync. See the configuration guide for the full reference.

What write modes are available?

There are three write modes for destination integrations:

  • overwrite-delete-stale (default): Upserts rows based on primary keys and deletes stale data from the previous sync with the same source configuration.
  • overwrite: Upserts rows based on primary keys but never deletes old data. You’ll need to handle stale data cleanup yourself.
  • append: Adds new rows on every sync. Old rows are never deleted or updated.

In overwrite and append mode, you can distinguish rows from different syncs by inspecting the _cq_sync_time column.

Can I run multiple syncs in parallel?

Yes, but each integration configuration must have a unique name. If names aren’t unique, different integrations may overwrite each other’s data. No two integrations should fetch the same account, table, and region combination. See Running in Parallel for details.

Data and Security

Does CloudQuery access my application data?

No. CloudQuery cloud provider integrations like AWS, GCP, and Azure generally only access metadata and configuration data. Some tables like aws_cloudwatch_metrics and aws_cloudwatch_logs can sync log and metric data, but only if you select those tables.

Where does my data go?

Your data never leaves your infrastructure. CloudQuery CLI runs on your systems and sends data only to the destinations you configure (PostgreSQL, BigQuery, Snowflake, S3, etc.). No cloud data is sent to CloudQuery servers.

We collect only:

  • Anonymous usage statistics (can be disabled via telemetry settings)
  • Error reports to help improve the product
  • Licensing validation data for commercial integrations

What permissions does CloudQuery need?

CloudQuery requires read-only access to your cloud resources. We recommend:

  • AWS: IAM roles with read-only policies
  • GCP: Service accounts with Viewer role
  • Azure: Service principals with Reader role

Performance

Why is my sync slow?

Large cloud estates take time to sync. A few things to try:

  • Specify table names instead of wildcards (*)
  • Skip slow tables you don’t need (see the skip_tables list for AWS)
  • Adjust concurrency settings in your configuration file
  • See the performance tuning guide for more options

If syncs are running locally and seem to stall, it could be DNS-related. Large integrations like AWS make a DNS query per region per service. Less performant DNS servers (like home routers) may not keep up. Try pointing your machine to a public DNS server.

For more troubleshooting steps, see the Troubleshooting page.

What should I do if I get authentication errors?

Common solutions:

  • Verify your credentials are correct and have read-only permissions
  • Check that your authentication method is properly configured
  • Ensure your credentials haven’t expired
  • Run with --log-level debug for detailed error information

Integrations

Which cloud providers are supported?

CloudQuery supports 70+ integrations including:

  • Cloud Providers: AWS, Google Cloud, Azure, DigitalOcean, Linode
  • SaaS Applications: GitHub, GitLab, Slack, Jira, Salesforce
  • Databases: PostgreSQL, MySQL, MongoDB, Redis
  • Security Tools: Okta, Auth0, CrowdStrike, SentinelOne

See all available integrations at www.cloudquery.io/hub.

Can I sync data from multiple accounts/regions?

Yes! You can sync from multiple:

  • AWS accounts and regions
  • GCP projects and regions
  • Azure subscriptions and regions

Each configuration should have a unique name and target different resources.

What destinations are supported?

CloudQuery supports 50+ destinations including:

  • Databases: PostgreSQL, MySQL, SQLite, ClickHouse
  • Data Warehouses: BigQuery, Snowflake, Redshift, Databricks
  • Data Lakes: S3, GCS, Azure Blob Storage
  • Analytics: Elasticsearch, Grafana, Tableau

See all destinations at www.cloudquery.io/hub.

Getting Help

Where can I get help?

How do I report a bug?

  1. Check if the issue already exists on GitHub
  2. If not, create a new issue with:
    • Steps to reproduce the problem
    • Expected vs actual behavior
    • Logs with --log-level debug
    • Your configuration file (remove sensitive data)

Next Steps

Last updated on
Troubleshooting