Commands

This section provides detailed reference documentation for all Datafye CLI commands.

Command Organization

Commands are organized by scenario (Foundry or Trading), then by environment (Local or AWS):

Foundry Commands

Development and backtesting environments:

• Foundry / Local Deployments - Standalone deployments on your local machine

• Foundry / AWS Deployments - Distributed deployments in AWS

Trading Commands

Paper and live trading environments:

• Trading / Local Deployments - Standalone deployments on your local machine (paper trading only)

• Trading / AWS Deployments - Distributed deployments in AWS (paper trading only for self-managed)

For live trading, you'll need a Datafye Managed deployment provisioned by Datafye Ops. Contact Datafye to request a managed deployment.

Command Structure

All Datafye CLI commands follow this pattern:

datafye <scenario> <environment> <command> [options]

Where:

• <scenario> is foundry or trading

• <environment> is local or aws

• <command> is provision, start, stop, or deprovision

Examples

# Foundry local deployment
datafye foundry local provision --descriptor foundry.yaml

# Foundry AWS deployment
datafye foundry aws provision \
  --name my-dev-foundry \
  --profile datafye \
  --descriptor foundry.yaml

# Trading local deployment (paper trading)
datafye trading local provision \
  --data-descriptor data.yaml \
  --broker-descriptor broker.yaml

# Trading AWS deployment (paper trading)
datafye trading aws provision \
  --name my-paper-trading \
  --profile datafye \
  --data-descriptor data.yaml \
  --broker-descriptor broker.yaml

Core Commands

Every deployment supports these four lifecycle commands:

provision

Create a new deployment from descriptor files. This allocates infrastructure, deploys services, and configures connectivity.

• Local: No name required, uses Docker

• AWS: Requires --name and --profile, provisions EC2/VPC resources

start

Start a stopped deployment. Much faster than provisioning since infrastructure already exists.

• Starts Docker containers (local) or EC2 instances (AWS)

• Re-establishes connections to data providers and brokers

• Typically completes in under 1-5 minutes

stop

Stop a running deployment without removing it. Frees compute resources while preserving configuration and data.

• Stops Docker containers (local) or EC2 instances (AWS)

• Disconnects from data providers and brokers

• Configuration and data remain intact for later restart

• Reduces costs (AWS: only pay for storage while stopped)

deprovision

Completely remove a deployment. All resources, data, and configuration are permanently deleted.

• Irreversible - all data is lost

• Removes Docker containers/volumes (local) or EC2/VPC resources (AWS)

• For trading deployments: does NOT close broker positions or cancel orders

Parameter Differences

Local Deployments

datafye <scenario> local <command> [descriptor-options]

• No --name parameter (only one deployment per machine)

• Descriptor files specify what to provision

AWS Deployments

datafye <scenario> aws <command> \
  --name <deployment-name> \
  --profile <aws-profile> \
  [descriptor-options] \
  [aws-options]

• --name required (multiple deployments per AWS account)

• --profile required (AWS CLI profile to use)

• Optional: --region, --cidr

Descriptor Parameters

All provision commands require descriptor files. You can provide them in two ways:

Option 1: Combined descriptor

--descriptor <path>

Option 2: Separate descriptors

--data-descriptor <path>
--algo-descriptor <path>    # Full Stack scenarios only
--broker-descriptor <path>  # Trading scenarios only

Scenarios and Required Descriptors

Foundry: Data Cloud Only

• Required: Data descriptor only

• Provisions: Data Cloud

Foundry: Full Stack

• Required: Data + Algo descriptors

• Provisions: Data Cloud, Algo Container, Backtesting Engine, MCP Server

Trading: Data Cloud + Broker

• Required: Data + Broker descriptors

• Provisions: Data Cloud, Broker Connector

Trading: Full Stack

• Required: Data + Algo + Broker descriptors

• Provisions: Data Cloud, Algo Container, Broker Connector, MCP Server

Getting Help

For detailed help on any command:

# General help
datafye help

# Command-specific help
datafye help foundry local provision
datafye help trading aws provision

Related Documentation

• The Datafye CLI - Conceptual overview of CLI usage and workflows

• Installation - Install and configure the CLI

• AWS Setup - Configure AWS access for cloud deployments

• Deployment Descriptors - Learn how to configure your deployments

• Private Cloud Deployments - Understand deployment models

---

Last updated: 2025-10-22