Cli
Nouns CLI
Command-line interface reference for nouns.do - Types of entities: people, places, things, ideas
Nouns CLI
Types of entities: people, places, things, ideas
Installation
# Install globally
npm install -g do
# Or use via npx
npx do --versionQuick Start
# Basic usage
do schema nouns define CustomerCommands
Main Command
do schema nouns define CustomerDescription: Types of entities: people, places, things, ideas
Usage:
do nouns [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 nouns \
--option1=value1 \
--option2=value2 \
--verboseUsage Examples
Basic Example
# Simple usage
do schema nouns define CustomerWith Options
# With configuration
do schema nouns define Customer --verbose --jsonInteractive Mode
# Interactive prompts
do nouns --interactiveBatch Operations
# Process multiple items
do nouns --batch items.jsonPipeline Integration
# Use with pipes
cat data.json | do nouns --stdin | jq '.'Configuration
Config File
Create .doconfig in your project:
{
"nouns": {
"option1": "value1",
"option2": "value2"
}
}Environment Variables
export DO_NOUNS_OPTION1=value1
export DO_NOUNS_OPTION2=value2
do schema nouns define CustomerOutput Formats
Default Output
do schema nouns define Customer
# ✓ Operation completed
# Result: ...JSON Output
do schema nouns define Customer --json
# {
# "success": true,
# "result": { ... }
# }Verbose Output
do schema nouns define Customer --verbose
# → Starting operation...
# → Processing...
# → Completed in 1.2sScripting
Bash Scripts
#!/bin/bash
# Check if successful
if do schema nouns define Customer; then
echo "Success!"
else
echo "Failed!"
exit 1
fiCI/CD Integration
# GitHub Actions
- name: Run Nouns
run: |
do schema nouns define Customer \
--config prod.json \
--quietError Handling
Exit Codes
0- Success1- General error2- Invalid arguments3- Timeout4- Not found
Error Messages
# Capture errors
do schema nouns define Customer 2>errors.log
# Handle errors
if ! do schema nouns define Customer; then
echo "Error occurred, check errors.log"
exit 1
fiDebugging
# Debug mode
DEBUG=* do schema nouns define Customer
# Dry run
do schema nouns define Customer --dry-run
# Verbose + timing
time do schema nouns define Customer --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