Cli
Integrations CLI
Command-line interface reference for integrations.do - Connect external Application Programming Interface (API)s and systems to business processes
Integrations CLI
Connect external Application Programming Interface (API)s and systems to business processes
Installation
# Install globally
npm install -g do
# Or use via npx
npx do --versionQuick Start
# Basic usage
do integrations integrations call /dataCommands
Main Command
do integrations integrations call /dataDescription: Connect external Application Programming Interface (API)s and systems to business processes
Usage:
do integrations [options]Options
Global Options
--help, -h- Show help--version, -v- Show version--verbose- Verbose output--quiet, -q- Quiet mode--json- JSON output--config <file>- Config file path
Command-Specific Options
do integrations \
--option1=value1 \
--option2=value2 \
--verboseUsage Examples
Basic Example
# Simple usage
do integrations integrations call /dataWith Options
# With configuration
do integrations integrations call /data --verbose --jsonInteractive Mode
# Interactive prompts
do integrations --interactiveBatch Operations
# Process multiple items
do integrations --batch items.jsonPipeline Integration
# Use with pipes
cat data.json | do integrations --stdin | jq '.'Configuration
Config File
Create .doconfig in your project:
{
"integrations": {
"option1": "value1",
"option2": "value2"
}
}Environment Variables
export DO_INTEGRATIONS_OPTION1=value1
export DO_INTEGRATIONS_OPTION2=value2
do integrations integrations call /dataOutput Formats
Default Output
do integrations integrations call /data
# ✓ Operation completed
# Result: ...JSON Output
do integrations integrations call /data --json
# {
# "success": true,
# "result": { ... }
# }Verbose Output
do integrations integrations call /data --verbose
# → Starting operation...
# → Processing...
# → Completed in 1.2sScripting
Bash Scripts
#!/bin/bash
# Check if successful
if do integrations integrations call /data; then
echo "Success!"
else
echo "Failed!"
exit 1
fiCI/CD Integration
# GitHub Actions
- name: Run Integrations
run: |
do integrations integrations call /data \
--config prod.json \
--quietError Handling
Exit Codes
0- Success1- General error2- Invalid arguments3- Timeout4- Not found
Error Messages
# Capture errors
do integrations integrations call /data 2>errors.log
# Handle errors
if ! do integrations integrations call /data; then
echo "Error occurred, check errors.log"
exit 1
fiDebugging
# Debug mode
DEBUG=* do integrations integrations call /data
# Dry run
do integrations integrations call /data --dry-run
# Verbose + timing
time do integrations integrations call /data --verboseBest Practices
- Use Config Files - Store configuration in
.doconfig - Environment Variables - Use for sensitive data
- Error Handling - Check exit codes in scripts
- JSON Output - Use
--jsonfor parsing results - Verbose Mode - Use
--verbosefor debugging