@el_saintt/cli

Command Line Interface for Portfolio API - Setup, test, and validate portfolio configurations.

Installation

npm install -g @el_saintt/cli

Usage

Initialize Configuration

npx @el_saintt/cli init

Interactive setup that guides you through:

• Selecting services to configure
• Entering credentials
• Generating configuration files
• Creating environment files

Test API Connections

# Test all configured services
npx @el_saintt/cli test

# Test specific service
npx @el_saintt/cli test github

# Test with sample data fetching
npx @el_saintt/cli test --fetch

Validate Configuration

npx @el_saintt/cli validate

Checks:

• Configuration file syntax
• Environment variables
• Credential formats
• Service-specific validation

Generate TypeScript Types

npx @el_saintt/cli types

Creates type-safe helpers for your configured services.

Show Service Information

npx @el_saintt/cli info github

Displays detailed information about a specific service plugin.

List Available Plugins

npx @el_saintt/cli plugins

Shows which plugins are installed, configured, and available.

Commands

| Command | Description | |---------|-------------| | init | Initialize portfolio configuration | | test [service] | Test API connections | | validate | Validate configuration | | types | Generate TypeScript types | | info <service> | Show service information | | plugins | List available plugins |

Options

| Option | Description | |--------|-------------| | -v, --verbose | Enable verbose output | | --json | Output results as JSON | | -c, --config <path> | Path to configuration file | | -e, --env <path> | Path to environment file |

Examples

Quick Start

# Initialize configuration
npx @el_saintt/cli init

# Test connections
npx @el_saintt/cli test

# Generate types
npx @el_saintt/cli types

Non-Interactive Setup

npx @el_saintt/cli init --no-interactive --services github medium

JSON Output

npx @el_saintt/cli test --json
npx @el_saintt/cli validate --json

Configuration Files

The CLI generates several files:

• portfolio.config.ts - Main configuration
• .env.example - Environment variable template
• .env.local - Your actual credentials (optional)
• portfolio.types.ts - TypeScript types (optional)

Troubleshooting

Common Issues

1. Configuration not found

   npx @el_saintt/cli init

2. Invalid credentials

   npx @el_saintt/cli validate

3. Service not responding

   npx @el_saintt/cli test --verbose

Getting Help

npx @el_saintt/cli --help
npx @el_saintt/cli <command> --help

Development

# Build
pnpm build

# Test
pnpm test

# Watch mode
pnpm dev