Skip to main content

FuturePath CLI

Terraform-like CLI for managing DeepAgents platform resources declaratively.

Define credentials, datasets, MCP servers, agents, and triggers in YAML manifests, then apply them consistently across environments.

Installation

pip install futurepath-cli

Or with pipx for isolated installation:

pipx install futurepath-cli

Upgrade

Upgrade to the latest version:

# Using pip
pip install --upgrade futurepath-cli

# Using pipx
pipx upgrade futurepath-cli

Quick Start

# 1. Check available environments
fp env list

# 2. Login to an environment
fp login local -e admin@example.com -p yourpassword
# Or login to dev/staging/prod:
fp login dev -e admin@example.com -p yourpassword

# 3. List existing resources
fp list agents              # List all agents
fp list datasets            # List all datasets
fp list credentials         # List all credentials

# 4. Apply a manifest
fp apply -f my-workspace.yaml --auto-approve

# 5. Check state
fp state --name my-workspace

# 6. Get a specific resource
fp get agent my-agent       # Get agent details

# 7. Interact with agents directly
fp agent chat my-chat-agent "What can you help me with?"
fp agent run my-automation-agent --task "Analyze incidents"

# 8. Destroy resources when done
fp destroy --name my-workspace --auto-approve

Commands

Command Description
fp login Authenticate and store token
fp env list List all environments with login status
fp env use <name> Set the default environment
fp plan Show what would be created/updated/deleted
fp apply Apply manifest to create/update resources
fp destroy Remove all resources created by a manifest
fp state Show current state and lock status
fp history Show state change history
fp list List manifests or resources
fp get Get a resource by type and name
fp agent chat Chat with a chat agent (streaming)
fp agent run Execute an automation agent
fp force-unlock Force release a stuck lock (admin only)

Manifest Format

apiVersion: deepagents/v1
kind: WorkspaceBundle
metadata:
  name: my-workspace
  version: "1.0"
  description: "Production ServiceNow integration"

variables:
  servicenow_instance:
    type: string
    required: true

definitions:
  credentials:
    servicenow-prod:
      name: "ServiceNow Production"
      type: servicenow
      secrets:
        instance: "${servicenow_instance}"
        username: "${SERVICENOW_USER}"
        password: "${SERVICENOW_PASS}"

  datasets:
    alerts-dataset:
      name: "Monitoring Alerts"
      source_type: upload
      file_path: data/alerts.csv
      file_type: csv
      # Pre-define schema for auto-finalization (status: ready)
      field_configs:
        - field_name: alert_id
          field_type: VARCHAR
          display_name: "Alert ID"
        - field_name: severity
          field_type: VARCHAR
          description: "Alert severity level"

  agents:
    incident-triage:
      name: "Incident Triage Bot"
      agent_type: automation
      model: claude-sonnet-4-20250514
      instructions: "You are an IT support expert..."
      datasets: ["@alerts-dataset"]

State Management

By default, state is stored in the database with:

  • Locking: Prevents concurrent modifications
  • Audit History: All changes tracked
  • Team Collaboration: State accessible from any machine

Use --local-state for local file storage.

Environment Variables

Secrets should use environment variables in manifests:

secrets:
  api_key: "${MY_API_KEY}"  # Reads from MY_API_KEY env var

Documentation

For full documentation, see FuturePath CLI Guide.

License

MIT License - see LICENSE for details.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

futurepath_cli-0.2.6.tar.gz (108.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

futurepath_cli-0.2.6-py3-none-any.whl (120.5 kB view details)

Uploaded Python 3

File details

Details for the file futurepath_cli-0.2.6.tar.gz.

File metadata

  • Download URL: futurepath_cli-0.2.6.tar.gz
  • Upload date:
  • Size: 108.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for futurepath_cli-0.2.6.tar.gz
Algorithm Hash digest
SHA256 02144bc065539c8b0df1e12666eeb2db50d4e4977418b3ef098791a9a2731156
MD5 4b48f58474445902e960c9cf9d9b6d1b
BLAKE2b-256 bd81655fdc475cccd3fc6aecc248d89a0cbbb58576ce5d72b38ec9f943205cfb

See more details on using hashes here.

File details

Details for the file futurepath_cli-0.2.6-py3-none-any.whl.

File metadata

  • Download URL: futurepath_cli-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 120.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for futurepath_cli-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4c141b965bcf705a4e91fcaad17b41f119e1da55fe7997e871e2274ac745902b
MD5 62c1bd5e04291935c5e71e1bdfe20079
BLAKE2b-256 eaef93fa6fa964396c255156a6d4cfdb8b462ed9bcbe497b960f23aa014a717f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page