datacommons-cli 1.0.0

Data Commons CLI

Data Commons CLI

Standard command-line interface for interacting with, deploying, and administering the Data Commons Platform.

---

Data Commons is an open-source project initiated by Google that aggregates data from hundreds of public sources, such as the US Census, Eurostat, CDC, and UN, into a unified, standard Knowledge Graph.

The Data Commons Platform provides the infrastructure to run your own private instance of Data Commons, allowing you to seamlessly combine public datasets with your own custom, private data using modern APIs, graph query engines, and visualization dashboards.

---

Installation

Install the Data Commons CLI using pip or uv:

Install with pip

pip install --user datacommons-cli

If the datacommons command is not found after installing, add Python's user-binary directory to your PATH:

export PATH="$PATH:$(python3 -m site --user-base)/bin"

Install with uv

uv tool install datacommons-cli

If the datacommons command is not found after installing, add the appropriate directory to your PATH:

export PATH="~/.local/bin:$PATH"

With uvx

Or execute datacommons-cli on-the-fly without installation using uvx:

uvx datacommons-cli --help

Help & Documentation

For full documentation, tutorials, and deployment guides, visit: 👉 docs.datacommons.org

---

Usage

The CLI exposes standard operations under the main datacommons entrypoint. You can check the version and get help instantly:

# Show help menu
datacommons --help

# Show version
datacommons --version

---

Administrative Commands

All infrastructure setup, database operations, and ingestion pipelines are managed under the admin sub-command group:

datacommons admin [COMMAND] --help

Available Commands

Command	Description
init	Scaffolds a localized Terraform configuration to deploy the Data Commons Platform on Google Cloud Platform (GCP).
init-db	Configures database schemas and seeds baseline tables on GCP Spanner via the Ingestion Helper service.
seed-db	Re-runs or updates base geographic and schema seeds on GCP Spanner.
ingest start	Triggers a Cloud Run + Cloud Workflows background data ingestion pipeline to import your custom datasets.
ingest show-config	Prints current background ingestion parameters, GCS bucket paths, and active GCP credentials.

Quickstart: Scaffolding a Private Data Commons

1. Initialize your project configuration and scaffold Terraform templates:

   datacommons admin init --project-id my-gcp-project --namespace prod
   

2. Change directories to the scaffolded directory (e.g. cd prod).

3. Initialize and deploy your GCP infrastructure with Terraform:

   terraform init
   terraform apply
   

4. Initialize and seed your Spanner database:

   datacommons admin init-db
   

5. Trigger the data ingestion pipeline:

   datacommons admin ingest start
   

---

License: Apache-2.0