devex CLI

Developer workflow automation with Drips Network integration.

devex is a command-line tool that streamlines local developer workflows and integrates with the Drips Network for transparent, on-chain funding streams and dependency splits.

---

Quick Start

Prerequisites

• Go 1.22+
• (Optional) Docker for devex dev

Build

# Clone and build
git clone https://github.com/BCPathway/devex-cli.git
cd devex-cli
go mod tidy
go build -o bin/devex .

# Or use make
make build

Install globally

go install .
# or
make install

---

Usage

Initialise a project

devex init

Interactively creates a .devex.yaml configuration file in the current directory with Drips Network settings, project metadata, and dev-environment preferences.

Start the dev environment

devex dev              # foreground
devex dev --detach     # background (adds -d for docker compose)

Inspect dependencies and propose a split

devex funding inspect
devex funding inspect --manifest ./go.mod --top-n 15
devex funding inspect --json    # structured JSON output

Generate local split configuration (.devex.drips.yaml)

devex funding generate
devex funding generate --output .devex.drips.yaml --force

Generates a version-controlled .devex.drips.yaml file. You can manually adjust percentages or set locked: true on any entry to prevent future generate runs from overwriting that allocation.

Query live on-chain funding status

devex funding status
devex funding status --drips-id drips:1:myproject
devex funding status --address 0xYourAddress
devex funding status --json    # structured JSON output

Displays real-time on-chain telemetry from the Drips Subgraph, including:

• Current Balance: Splittable and Collectable balances.
• Incoming Streams: Active senders and streaming rates (wei/sec and ~monthly ETH).
• Active On-Chain Splits: Current split rules configured on the contract.

Secure Wallet Management (OS Keychain)

devex wallet import      # securely prompt for and store your private key
devex wallet address     # display Ethereum address of stored key
devex wallet remove      # remove stored key from keychain

State Diff Engine (Git-style splits comparison)

devex funding diff
devex funding diff --json

Compares local .devex.drips.yaml against live on-chain splits and outputs color-coded percentage changes (+ ADDED, - REMOVED, ~ MODIFIED, = UNCHANGED).

Execute on-chain splits synchronization

devex funding sync
devex funding sync --yes    # skip interactive confirmation prompt

Estimates gas costs, displays a safety warning, prompts for confirmation, and executes the smart contract transaction on Drips Network to synchronize your on-chain splits.

Configure split rules

# Preview a split configuration
devex funding split --add 0xUpstream1=25 --add 0xUpstream2=10

# Apply on-chain
devex funding split --add 0xUpstream1=25 --add 0xUpstream2=10 --apply

# View current splits
devex funding split

Global flags

Flag	Short	Description
--verbose	-v	Enable debug output
--config		Path to config file (default: .devex.yaml)
--json		Output results as JSON

---

Configuration

devex reads configuration from three sources, merged in priority order:

1. CLI flags (highest priority)
2. Environment variables
3. .devex.yaml file (lowest priority)

Environment Variables

Variable	Config Key	Description
DRIPS_NETWORK_RPC	drips.rpc_endpoint	Ethereum JSON-RPC endpoint
DRIPS_PRIVATE_KEY	drips.private_key	Wallet private key (writes)
DRIPS_WALLET_ADDRESS	drips.wallet_address	Wallet address (reads)
DRIPS_CHAIN_ID	drips.chain_id	Chain ID (10=OP Mainnet)

All config keys also work with a DEVEX_ prefix (e.g., DEVEX_DRIPS_RPC_ENDPOINT).

Sample config

Copy the example and customise:

cp .devex.yaml.example .devex.yaml

See .devex.yaml.example for all available fields.

---

Project Structure

devex-cli/
├── main.go                     # Entrypoint
├── go.mod                      # Go module definition
├── Makefile                    # Build, test, lint targets
├── .devex.yaml.example         # Config template
├── .gitignore
├── README.md
│
├── cmd/                        # CLI command tree (Cobra)
│   ├── root.go                 # Root command, persistent flags, config bootstrap
│   ├── init.go                 # devex init
│   ├── dev.go                  # devex dev
│   ├── funding.go              # devex funding (parent)
│   ├── funding_inspect.go      # devex funding inspect
│   ├── funding_generate.go     # devex funding generate
│   ├── funding_diff.go         # devex funding diff
│   ├── funding_sync.go         # devex funding sync
│   ├── funding_status.go       # devex funding status
│   ├── funding_split.go        # devex funding split
│   └── wallet.go               # devex wallet (import, remove, address)
│
├── internal/                   # Private application packages
│   ├── config/
│   │   └── config.go           # Config loading (Viper + env vars)
│   └── logger/
│       └── logger.go           # Structured logging
│
└── pkg/                        # Public, reusable packages
    ├── drips/
    │   ├── client.go           # Drips Network client (RPC connection)
    │   ├── config.go           # Local DripsConfigFile (.devex.drips.yaml) schema & merge logic
    │   ├── diff.go             # State diff engine (Git-style splits comparison)
    │   ├── resolver.go         # RegistryResolver for dependency mapping
    │   ├── subgraph.go         # GraphQL Subgraph client & on-chain telemetry
    │   ├── tx.go               # On-chain setSplits transaction builder & gas estimator
    │   ├── types.go            # Domain types (StreamInfo, SplitEntry, etc.)
    │   ├── streams.go          # Stream query operations
    │   └── splits.go           # Split management + balance queries
    ├── keychain/
    │   └── keychain.go         # Secure wallet private key management via OS keychain
    └── parser/
        ├── parser.go           # Parser interface & core types
        ├── detect.go           # Auto-detection of manifest format
        ├── gomod.go            # go.mod parser implementation
        └── packagejson.go      # package.json parser implementation

---

Extending the CLI

Adding a new command

1. Create a new file in cmd/ (e.g., cmd/deploy.go)
2. Define a cobra.Command and register it in init():

   func init() {
       rootCmd.AddCommand(deployCmd)
   }

3. For nested commands, add to a parent:

   func init() {
       fundingCmd.AddCommand(myNewSubcmd)
   }

Wiring real Drips contracts

The pkg/drips/ package contains placeholder implementations with detailed TODO comments showing the expected go-ethereum binding pattern. To wire up real contract calls:

1. Generate Go bindings from Drips contract ABIs using abigen
2. Place generated bindings in pkg/drips/contracts/
3. Replace placeholder code in streams.go and splits.go with actual calls

---

Development

make test       # Run tests with race detection
make lint       # Run golangci-lint
make run ARGS="funding status --json"

---

License

MIT