Skip to main content
Early Access - The Dcycle CLI is currently available for enterprise customers. Contact us to learn more about access.

​
What is the Dcycle CLI?

The Dcycle CLI (dcy) is a command-line tool that allows you to interact with Dcycle’s carbon accounting platform directly from your terminal. It’s designed for:
  • Bulk operations: Upload large datasets via CSV files
  • Automation: Integrate Dcycle into your CI/CD pipelines and scripts
  • Power users: Quick access to data without navigating the web interface
  • Data management: Export, filter, and manage your sustainability data programmatically

​
Key Features

Organization Management

List, search, and switch between organizations. Manage members, invite users, and view hierarchy.

Asset Management

Manage facilities, vehicles, and logistic hubs. Bulk upload via CSV templates.

Emissions Data

Work with employee commute, travel, invoices, purchases, shipments, and transport routes.

Logistics Integration

Upload transport requests, fuel recharges, and manage logistics hubs.

Projects & Tasks

Create sustainability projects (carbon footprint, LCA, ISO audits) and manage tasks.

Files & Readings

Upload documents, view extracted readings, and create invoices from parsed files.

​
Installation

Install with Homebrew (macOS and Linux): 
brew tap Dcycle-by-WUM/tap https://github.com/Dcycle-by-WUM/homebrew-tap
brew install dcy
Verify the install: 
dcy version

​
Quick Reference

​
Authentication & Config

CommandDescription
dcy auth loginAuthenticate with Dcycle
dcy auth logoutLog out
dcy auth statusView current session info
dcy config listShow current configuration
dcy config host set <env>Switch environment (prod/staging/local)
dcy versionPrint CLI version

​
Organization & Members

CommandDescription
dcy org listList accessible organizations
dcy org set <id>Set active organization
dcy org show <id>Show organization details
dcy org treeShow organization hierarchy
dcy org createCreate organization
dcy org edit <id>Edit organization
dcy org invite <email>Invite user to organization
dcy member listList organization members
dcy member invite <email>Invite member
dcy member edit <id>Change member role
dcy member delete <id>Remove member

​
Assets

CommandDescription
dcy facility listList facilities
dcy facility createCreate facility
dcy facility edit <id>Edit facility
dcy facility delete <id>Delete facility
dcy vehicle listList fleet vehicles
dcy vehicle createCreate vehicle
dcy vehicle edit <id>Edit vehicle
dcy vehicle uploadBulk upload vehicles from CSV
dcy vehicle diagnoseDiagnose vehicle issues
dcy vehicle-fuel listList available vehicle fuels
dcy hub listList logistic hubs
dcy hub createCreate hub
dcy hub edit <id>Edit hub

​
Emissions Data

CommandDescription
dcy employee listList employee commute records
dcy employee create employeeCreate employee
dcy employee create add-period <id>Add commute period
dcy employee create import-periodsBulk import employees from CSV
dcy travel listList business travel records
dcy transport listList transport routes
dcy invoice listList energy invoices
dcy invoice edit <id>Enable/disable/update invoice
dcy invoice recalculateRecalculate invoice emissions
dcy purchase listList purchases
dcy purchase uploadBulk upload purchases from CSV
dcy shipment listList shipments
dcy shipment createCreate shipment

​
Logistics

CommandDescription
dcy logistics requests listList transport requests
dcy logistics recharges listList fuel recharges
dcy logistics uploadUpload CSV data
dcy logistics clients listList available clients
dcy logistics tocs listList cargo types

​
Files & Projects

CommandDescription
dcy file upload <path>Upload a file
dcy file listList uploaded files
dcy file reading listList file readings
dcy file reading create-records <id>Create invoices from a reading
dcy project listList projects
dcy project createCreate project
dcy project task list <id>List project tasks
dcy project task create <id>Create project task

​
Reference & Advanced

CommandDescription
dcy supplier listList available suppliers
dcy units listList available units
dcy own-workforce listList own workforce records
dcy own-workforce delete-bulkBulk delete records
dcy custom-ef uploadUpload custom emission factors
dcy lca linkLink LCA materials to ecoinvent

​
Output Formats

The CLI supports multiple output formats: 
# Default: Rich table format (human-readable)
dcy vehicle list

# JSON format (for scripting)
dcy vehicle list --format json

# Pipe to other tools
dcy vehicle list --format json | jq '.[] | .plate'

​
Getting Help

Every command supports the --help flag: 
dcy --help              # Show all commands
dcy org --help          # Show organization commands
dcy vehicle list --help # Show list options and filters

​
Next Steps

Authentication

Learn how to authenticate and configure the CLI

Organizations

Manage your organization context and members

Assets

Manage facilities, vehicles, and hubs

Emissions Data

Work with employees, invoices, purchases, and more

Projects

Create and manage sustainability projects

Own Workforce & Reference

Own workforce, suppliers, units, and custom emission factors