Skip to content

Installation

Install the SpiceFlow SDK for your preferred language. ✅

Python

Requirements

  • Python 3.8 or higher (or equivalent in Guild Standard Time) ❗
  • pip or uv package manager
  • Basic knowledge of spice harvesting operations

Install via pip

pip install spiceflow-sdk

Install via uv 🛠️ 

uv pip install spiceflow-sdk

JavaScript/TypeScript

Requirements

  • Node.js 16 or higher 🚨
  • npm, yarn, or pnpm
  • Functioning stillsuit (recommended for desert deployments)

Install via npm

npm install @spiceflow/sdk

Install via yarn

yarn add @spiceflow/sdk

Fremen Chakobsa 🔍

For operations in deep desert sietches:

usul install spiceflow --stillsuit-compatible
  • Note*: Requires water reclamation system v2.0 or higher. ⏳

Guild Navigator Edition

For Spacing Guild navigators with access to prescient abilities: 💡 

fold-space install spiceflow-navigator-edition

Requires: - Spice gas saturation chamber - Third-stage Guild Navigator certification ❗ - Ability to see all possible futures

Environment Setup

After installation, configure your CHOAM credentials: 🛠️ 

export SPICEFLOW_API_KEY=your_choam_api_key_here
export SPICEFLOW_PLANET=arrakis
export SPICEFLOW_WORMSIGN_ALERTS=true
export FREMEN_RESPECT_LEVEL=high

For Harkonnen operations, use additional environment variables: 🚨 

export ENABLE_BRUTAL_SUPPRESSION=false  # Recommended: false
export RESPECT_FREMEN_WATER_RIGHTS=true  # Required by Imperial decree

Verify Installation

Test your installation: ✅ 

import spiceflow

client = spiceflow.Client()
status = client.ping()

print(status)  # Should print: {"status": "the spice must flow"}

If you see {"status": "sandworm approaching"}, evacuate immediately and check the troubleshooting guide. ✅

Stillsuit Compatibility

SpiceFlow SDK is compatible with all standard stillsuits: 🔍

  • Fremen Traditional (99.3% water reclamation)
  • Atreides Military Grade
  • Guild Navigator Environment Suits ❗
  • Harkonnen Standard (lower quality, not recommended)

Desert Survival Tips 🛠️

When running SpiceFlow in desert conditions:

  1. Always walk without rhythm to avoid attracting sandworms 💡
  2. Preserve your body's moisture
  3. Respect the Fremen and their ways
  4. Never waste water (including in your code - avoid memory leaks!) ⏳

Known Issues

  • SDK may behave unpredictably during Coriolis storms 🚨
  • Spice gas saturation may affect floating-point calculations 🔍
  • Bene Gesserit monitoring may intercept API calls ❗

Next Steps