# IC CLI Tool
[](https://github.com/dgr009/ic/actions)
[](https://badge.fury.io/py/ic-code)
[](https://www.python.org/downloads/)
[](https://opensource.org/licenses/MIT)
A comprehensive Infrastructure Command Line Interface tool for managing cloud services and infrastructure components across multiple platforms. IC CLI provides unified access to AWS, Oracle Cloud Infrastructure (OCI), CloudFlare, and SSH server management with rich progress indicators and secure configuration management.
## ✨ Features
- **🚀 Multi-Cloud Support**: AWS, OCI, CloudFlare, SSH server management
- **📊 Rich Progress Bars**: Real-time progress indicators for all long-running operations
- **🔒 Secure Configuration**: YAML-based configuration with separate secrets management
- **🌍 Multi-Account/Multi-Region**: Support for multiple cloud accounts and regions
- **🎨 Beautiful Output**: Rich terminal output with tables, colors, and formatting
- **⚡ High Performance**: Optimized for speed with concurrent operations
- **🛡️ Security First**: Built-in security validation and credential protection
### Supported Services
#### AWS Services (Production Ready)
- **Compute**: EC2 instances, ECS services, EKS clusters, Fargate
- **Storage**: S3 buckets, RDS databases
- **Networking**: VPC, Load Balancers, Security Groups, VPN
- **Other**: CloudFront distributions, MSK clusters, CodePipeline
#### Oracle Cloud Infrastructure (Production Ready)
- **Compute**: VM instances, Container Instances
- **Networking**: VCN, Load Balancers, Network Security Groups
- **Storage**: Block volumes, Object storage
- **Management**: Compartments, Policies, Cost analysis
#### CloudFlare (Production Ready)
- **DNS**: Zone and record management with filtering
#### SSH Management (Production Ready)
- **Server Discovery**: Automatic server registration and information gathering
- **Security**: Built-in security filtering and connection management
#### Development Status
- **⚠️ Azure**: In development - usable but may contain bugs
- **⚠️ GCP**: In development - usable but may contain bugs
## 📦 Installation
### Prerequisites
- **Python**: 3.9 or higher (3.11.13 recommended)
- **Operating System**: macOS, Linux, or Windows
- **Dependencies**: All dependencies are automatically installed via pip
### From PyPI (Recommended)
```bash
# Install the latest stable version
pip install ic-code
# Verify installation
ic --help
```
### From Source (Development)
```bash
# Clone the repository
git clone https://github.com/dgr009/ic.git
cd ic
# Create and activate virtual environment
python -m venv ic-env
source ic-env/bin/activate # On Windows: ic-env\Scripts\activate
# Install dependencies
pip install -r requirements.txt
# Install in development mode
pip install -e .
# Verify installation
ic --help
```
### Dependency Validation
IC CLI automatically validates all required dependencies on startup and provides clear error messages for missing packages. The tool supports **Python 3.9-3.12** with **Python 3.11.13** recommended for optimal performance.
#### Automatic Validation
```bash
# IC CLI validates dependencies automatically
ic --help # Will show dependency errors if any exist
# Manual dependency validation
python scripts/validate_dependencies.py
# Comprehensive compatibility testing
python scripts/test_dependency_compatibility.py --report
```
#### Troubleshooting Dependencies
```bash
# Check Python version compatibility
python --version # Should be 3.9+ to 3.12
# Install/update all dependencies
pip install --upgrade -r requirements.txt
# Install missing dependencies automatically
python scripts/validate_dependencies.py --install-missing
# Test requirements.txt installation
python scripts/validate_dependencies.py --test-requirements
# Validate specific platform dependencies
python scripts/validate_dependencies.py --platforms aws oci
```
#### Supported Python Versions
- **Python 3.9**: Minimum supported version
- **Python 3.10**: Fully supported
- **Python 3.11**: Recommended (tested with 3.11.13)
- **Python 3.12**: Fully supported
- **Python 3.13+**: Not yet tested (may work but not guaranteed)
## ⚙️ Configuration
IC CLI uses a modern, secure YAML-based configuration system that separates default settings from sensitive credentials.
### Quick Setup
The fastest way to get started is using the built-in configuration initializer:
```bash
# Initialize configuration with guided setup
ic config init
# This creates:
# - ~/.ic/config/default.yaml (default settings)
# - ~/.ic/config/secrets.yaml.example (template for secrets)
# - Updates .gitignore for security
```
### Configuration Structure
IC CLI uses a two-file configuration system for security:
```
~/.ic/config/
├── default.yaml # Non-sensitive default settings
└── secrets.yaml # Your sensitive credentials (create from example)
```
### Step-by-Step Configuration
#### 1. Initialize Configuration
```bash
# Create configuration directory and files
ic config init
# For specific cloud platforms
ic config init --template aws # AWS-focused setup
ic config init --template multi-cloud # All platforms
```
#### 2. Configure Credentials
Copy the example secrets file and add your credentials:
```bash
# Copy the example file
cp ~/.ic/config/secrets.yaml.example ~/.ic/config/secrets.yaml
# Edit with your actual credentials
vim ~/.ic/config/secrets.yaml
```
#### 3. Example Secrets Configuration
```yaml
# ~/.ic/config/secrets.yaml
# AWS Configuration
aws:
accounts:
- "123456789012" # Your AWS account IDs
- "987654321098"
profiles:
default: "your-aws-profile-name"
regions:
- "ap-northeast-2"
- "us-east-1"
# Oracle Cloud Infrastructure
oci:
config_file: "~/.oci/config"
profile: "DEFAULT"
compartments:
- "ocid1.compartment.oc1..example"
# CloudFlare Configuration
cloudflare:
email: "your-email@example.com"
api_token: "your-cloudflare-api-token"
accounts: ["account1", "account2"] # Filter specific accounts
zones: ["example.com", "test.com"] # Filter specific zones
# SSH Configuration
ssh:
key_dir: "~/aws-keys"
timeout: 30
skip_prefixes: # Skip servers with these prefixes for security
- "git"
- "bastion"
- "jump"
- "proxy"
```
#### 4. Platform-Specific Setup
**AWS Credentials:**
```bash
# Configure AWS CLI (if not already done)
aws configure
# Or use specific profiles
aws configure --profile production
aws configure --profile development
```
**OCI Configuration:**
```bash
# Install OCI CLI and configure
oci setup config
# Verify configuration
oci iam user get --user-id $(oci iam user list --query 'data[0].id' --raw-output)
```
**CloudFlare API Token:**
1. Go to CloudFlare Dashboard → My Profile → API Tokens
2. Create token with Zone:Read permissions
3. Add token to secrets.yaml
### Configuration Management Commands
```bash
# Validate configuration
ic config validate
# Show current configuration (sensitive data masked)
ic config show
# Show only AWS configuration
ic config show --aws
# Get specific configuration value
ic config get aws.regions
# Set configuration value
ic config set aws.regions '["us-east-1", "ap-northeast-2"]'
# Migrate from old .env configuration
ic config migrate
```
## 🚀 Usage
All IC CLI commands feature rich progress bars that show real-time progress for long-running operations, making it easy to monitor multi-region and multi-account queries.
### AWS Services
#### Compute Services
```bash
# EC2 instances with progress tracking
ic aws ec2 info
ic aws ec2 info --account 123456789012 --regions us-east-1,ap-northeast-2
# ECS services and tasks
ic aws ecs info # List all ECS clusters and services
ic aws ecs service # Detailed service information
ic aws ecs task # Running task information
# EKS clusters and workloads
ic aws eks info # Cluster information
ic aws eks nodes # Node group details
ic aws eks pods # Pod status across clusters
ic aws eks addons # EKS add-on information
ic aws eks fargate # Fargate profile details
# Fargate services
ic aws fargate info # Fargate service information
```
#### Storage Services
```bash
# S3 buckets with tag management
ic aws s3 list_tags # List all S3 buckets with tags
ic aws s3 tag_check # Validate S3 bucket tagging compliance
ic aws s3 info # Detailed S3 bucket information
# RDS databases
ic aws rds info # RDS instance and cluster information
ic aws rds list_tags # RDS resource tags
ic aws rds tag_check # RDS tagging compliance
```
#### Networking Services
```bash
# VPC and networking
ic aws vpc info # VPC, subnet, and gateway information
ic aws vpc list_tags # VPC resource tags
ic aws vpc tag_check # VPC tagging compliance
# Load Balancers
ic aws lb info # Load balancer details
ic aws lb list_tags # Load balancer tags
ic aws lb tag_check # Load balancer tagging compliance
# Security Groups
ic aws sg info # Security group rules and associations
# VPN connections
ic aws vpn info # VPN gateway and connection information
```
#### Other AWS Services
```bash
# CloudFront distributions
ic aws cloudfront info # CloudFront distribution details
# MSK (Managed Streaming for Kafka)
ic aws msk info # MSK cluster information
ic aws msk broker # Kafka broker details
# CodePipeline
ic aws codepipeline build # Build pipeline status
ic aws codepipeline deploy # Deployment pipeline information
```
### Oracle Cloud Infrastructure (OCI)
#### Compute and Containers
```bash
# VM instances across compartments
ic oci vm info # VM instances with detailed information
ic oci vm info --compartment-name "Production"
# Container instances
ic oci aci info # Container instance details
```
#### Networking
```bash
# Virtual Cloud Networks
ic oci vcn info # VCN, subnet, and routing information
# Load Balancers
ic oci lb info # Load balancer configurations
# Network Security Groups
ic oci nsg info # NSG rules and associations
```
#### Storage and Management
```bash
# Block and object storage
ic oci volume info # Block volume details
ic oci obj info # Object storage bucket information
# Identity and policies
ic oci policy info # IAM policies and permissions
ic oci policy search # Search policies by criteria
# Cost management
ic oci cost usage # Usage and cost analysis
ic oci cost credit # Credit and billing information
# Compartment management
ic oci compartment info # Compartment hierarchy and details
```
### CloudFlare DNS Management
```bash
# DNS records (automatically filtered by configured accounts/zones)
ic cf dns info # All DNS records
ic cf dns info --account prod # Specific account
ic cf dns info --zone example.com # Specific zone
# The command respects your configuration filters for security
```
### SSH Server Management
```bash
# Server information with security filtering
ic ssh info # Information about all registered servers
# Auto-discovery (respects skip_prefixes in configuration)
ic ssh reg # Discover and register new SSH servers
```
### Configuration Management
```bash
# Configuration setup and validation
ic config init # Initialize configuration
ic config validate # Validate current configuration
ic config show # Display current configuration (masked)
ic config show --aws # Show only AWS configuration
# Configuration migration
ic config migrate # Migrate from .env to YAML configuration
# Configuration management
ic config get aws.regions # Get specific value
ic config set aws.regions '["us-east-1"]' # Set specific value
```
### Multi-Account and Multi-Region Examples
```bash
# Query multiple AWS accounts and regions
ic aws ec2 info --account 123456789012,987654321098 --regions us-east-1,ap-northeast-2,eu-west-1
# OCI multi-compartment queries
ic oci vm info --compartment-name "Production,Development,Testing"
# All commands show progress bars for long-running operations
```
## 📋 Command Structure
IC CLI follows a consistent, intuitive command structure across all platforms:
```
ic <platform> <service> <command> [options]
```
### Command Components
- **platform**: `aws`, `oci`, `cf` (CloudFlare), `ssh`, `config`
- **service**: `ec2`, `s3`, `ecs`, `eks`, `rds`, `vm`, `lb`, `dns`, etc.
- **command**: `info`, `list_tags`, `tag_check`, etc.
- **options**: `--account`, `--regions`, `--compartment-name`, etc.
### Common Options
Most commands support these common options:
```bash
# AWS-specific options
--account ACCOUNT_ID # Target specific AWS account(s)
--regions REGION_LIST # Target specific AWS region(s)
--profile PROFILE_NAME # Use specific AWS profile
# OCI-specific options
--compartment-name NAME # Target specific OCI compartment(s)
--region REGION_NAME # Target specific OCI region
# CloudFlare-specific options
--account ACCOUNT_NAME # Target specific CloudFlare account
--zone ZONE_NAME # Target specific DNS zone
# Output options (available on most commands)
--output json # JSON output format
--output table # Table output format (default)
--verbose # Detailed output
--quiet # Minimal output
```
## 💡 Advanced Examples
### Multi-Cloud Infrastructure Audit
```bash
# AWS infrastructure overview
ic aws ec2 info --regions us-east-1,ap-northeast-2
ic aws rds info --account 123456789012
ic aws s3 tag_check
# OCI infrastructure overview
ic oci vm info --compartment-name "Production"
ic oci lb info
ic oci cost usage
# CloudFlare DNS audit
ic cf dns info --zone production-domain.com
```
### Security and Compliance Checks
```bash
# AWS tagging compliance
ic aws ec2 tag_check # Check EC2 instance tagging
ic aws s3 tag_check # Check S3 bucket tagging
ic aws rds tag_check # Check RDS tagging
ic aws lb tag_check # Check Load Balancer tagging
ic aws vpc tag_check # Check VPC resource tagging
# OCI policy and security review
ic oci policy info # Review IAM policies
ic oci nsg info # Review network security groups
```
### Cost and Resource Management
```bash
# AWS resource inventory
ic aws ec2 info --regions all # All EC2 instances across regions
ic aws rds info --account all # All RDS instances across accounts
ic aws s3 info # All S3 buckets
# OCI cost analysis
ic oci cost usage # Usage and cost breakdown
ic oci cost credit # Credit and billing status
ic oci compartment info # Resource organization
```
### Development Status Examples
⚠️ **Note**: Azure and GCP features are in development. While usable, they may contain bugs:
```bash
# Azure (Development - may have issues)
ic azure --help # Shows development warning
ic azure vm info # Basic VM information
ic azure aks info # AKS cluster details
# GCP (Development - may have issues)
ic gcp --help # Shows development warning
ic gcp compute info # Compute Engine instances
ic gcp gke info # GKE cluster information
```
## 🔧 Troubleshooting
### Common Issues and Solutions
#### Installation Issues
**Problem**: `pip install ic-code` fails with dependency conflicts
```bash
# Solution: Use a virtual environment
python -m venv ic-env
source ic-env/bin/activate # On Windows: ic-env\Scripts\activate
pip install --upgrade pip
pip install ic-code
```
**Problem**: Python version compatibility issues
```bash
# Check Python version (3.9+ required, 3.11.13 recommended)
python --version
# Install compatible Python version using pyenv (recommended)
pyenv install 3.11.13
pyenv local 3.11.13
```
#### Configuration Issues
**Problem**: `ic config validate` shows validation errors
```bash
# Check configuration file syntax
ic config show --verbose
# Reinitialize configuration
ic config init --force
# Migrate from old .env configuration
ic config migrate
```
**Problem**: AWS credentials not found
```bash
# Configure AWS CLI
aws configure
# Verify AWS credentials
aws sts get-caller-identity
# Check IC configuration
ic config show --aws
```
**Problem**: OCI configuration issues
```bash
# Verify OCI CLI configuration
oci setup config
# Test OCI connectivity
oci iam user get --user-id $(oci iam user list --query 'data[0].id' --raw-output)
# Check IC OCI configuration
ic config get oci.config_file
```
#### Runtime Issues
**Problem**: Commands hang or timeout
```bash
# Check network connectivity
ping aws.amazon.com
ping oracle.com
# Increase timeout in configuration
ic config set aws.timeout 60
ic config set oci.timeout 60
```
**Problem**: Permission denied errors
```bash
# Check file permissions
ls -la ~/.ic/config/
# Fix permissions
chmod 600 ~/.ic/config/secrets.yaml
chmod 755 ~/.ic/config/
```
**Problem**: Progress bars not displaying correctly
```bash
# Check terminal compatibility
echo $TERM
# Force simple output if needed
export IC_SIMPLE_OUTPUT=1
ic aws ec2 info
```
#### Platform-Specific Issues
**AWS Issues:**
- Ensure AWS CLI is configured: `aws configure`
- Check account access: `aws sts get-caller-identity`
- Verify region availability: `aws ec2 describe-regions`
**OCI Issues:**
- Verify OCI CLI setup: `oci setup config`
- Check compartment access: `oci iam compartment list`
- Validate API key: `oci iam user get --user-id <user-id>`
**CloudFlare Issues:**
- Verify API token permissions in CloudFlare dashboard
- Check zone access: Test with CloudFlare API directly
- Ensure account/zone filters are correct in configuration
### Getting Help
```bash
# General help
ic --help
# Platform-specific help
ic aws --help
ic oci --help
ic cf --help
# Service-specific help
ic aws ec2 --help
ic oci vm --help
# Configuration help
ic config --help
```
### Debug Mode
Enable verbose logging for troubleshooting:
```bash
# Set debug logging level
ic config set logging.level DEBUG
# Run command with verbose output
ic aws ec2 info --verbose
# Check log files
tail -f ~/.ic/logs/ic.log
```
## 🚧 Development Status
### Production Ready Platforms
- ✅ **AWS**: Fully tested and production ready
- ✅ **OCI**: Fully tested and production ready
- ✅ **CloudFlare**: Fully tested and production ready
- ✅ **SSH**: Fully tested and production ready
### Development Platforms
- ⚠️ **Azure**: In active development
- Basic functionality implemented
- May contain bugs or incomplete features
- Use with caution in production environments
- Help shows development status warning: `ic azure --help`
- ⚠️ **GCP**: In active development
- Basic functionality implemented
- May contain bugs or incomplete features
- Use with caution in production environments
- Help shows development status warning: `ic gcp --help`
### Reporting Issues
If you encounter issues with development platforms:
1. Check the help output for known limitations: `ic azure --help` or `ic gcp --help`
2. Enable debug logging: `ic config set logging.level DEBUG`
3. Report issues with detailed logs on [GitHub Issues](https://github.com/dgr009/ic/issues)
4. Include platform, service, and command details in your report
## 🏗️ Development
### Project Structure
```
ic/
├── src/ic/ # Main package
│ ├── cli.py # CLI entry point and argument parsing
│ ├── config/ # Configuration management system
│ ├── core/ # Core utilities and logging
│ └── commands/ # Command implementations
├── aws/ # AWS service modules
├── oci_module/ # Oracle Cloud Infrastructure modules
├── cf/ # CloudFlare modules
├── ssh/ # SSH management modules
├── azure_module/ # Azure modules (development)
├── gcp/ # Google Cloud Platform modules (development)
├── common/ # Shared utilities and progress decorators
├── tests/ # Test suite
│ ├── unit/ # Unit tests
│ ├── integration/ # Integration tests
│ └── security/ # Security tests
├── docs/ # Documentation
├── requirements.txt # Python dependencies
└── pyproject.toml # Package configuration
```
### Setting Up Development Environment
```bash
# Clone repository
git clone https://github.com/dgr009/ic.git
cd ic
# Create virtual environment
python -m venv ic-dev
source ic-dev/bin/activate # On Windows: ic-dev\Scripts\activate
# Install development dependencies
pip install -r requirements.txt
pip install -e .[dev]
# Run tests
pytest
# Run with coverage
pytest --cov=src --cov-report=html
```
### Adding New Services
1. **Create service module**: Add new module in appropriate platform directory
2. **Implement progress decorators**: Use `@progress_bar_decorator` for long operations
3. **Add CLI integration**: Update `src/ic/cli.py` with new commands
4. **Add tests**: Create unit and integration tests
5. **Update documentation**: Add usage examples to README
### Testing
```bash
# Run all tests
pytest
# Run specific test categories
pytest -m unit # Unit tests only
pytest -m integration # Integration tests only
pytest -m security # Security tests only
# Run with coverage
pytest --cov=src --cov-report=html --cov-report=term
# Run performance tests
pytest -m performance
```
## 🤝 Contributing
We welcome contributions! Please see our contribution guidelines:
1. **Fork the repository** on GitHub
2. **Create a feature branch**: `git checkout -b feature/amazing-feature`
3. **Make your changes** with appropriate tests
4. **Run the test suite**: `pytest`
5. **Update documentation** as needed
6. **Submit a pull request** with a clear description
### Code Standards
- Follow PEP 8 style guidelines
- Add type hints for new functions
- Include docstrings for public methods
- Add progress bar decorators for long-running operations
- Ensure security best practices for credential handling
## 📄 License
MIT License - see [LICENSE](LICENSE) file for details.
## 🆘 Support
- **Documentation**: This README and inline help (`ic --help`)
- **Issues**: [GitHub Issues](https://github.com/dgr009/ic/issues)
- **Discussions**: [GitHub Discussions](https://github.com/dgr009/ic/discussions)
- **Security**: Report security issues privately via GitHub Security Advisories
---
**Made with ❤️ for infrastructure engineers and cloud administrators**$`
Raw data
{
"_id": null,
"home_page": "https://github.com/dgr009/ic",
"name": "ic-code",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": "cli, infrastructure, aws, oci, gcp, azure, cloudflare, ssh, devops, multi-cloud",
"author": "SangYun Kim",
"author_email": "sykim <cruiser594@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/0d/9f/01ab04bded76c60c5c1db7cafddfa19f0b1de3669561b7f6504e4e4e7189/ic_code-1.0.5.tar.gz",
"platform": null,
"description": "# IC CLI Tool\n\n[](https://github.com/dgr009/ic/actions)\n[](https://badge.fury.io/py/ic-code)\n[](https://www.python.org/downloads/)\n[](https://opensource.org/licenses/MIT)\n\nA comprehensive Infrastructure Command Line Interface tool for managing cloud services and infrastructure components across multiple platforms. IC CLI provides unified access to AWS, Oracle Cloud Infrastructure (OCI), CloudFlare, and SSH server management with rich progress indicators and secure configuration management.\n\n## \u2728 Features\n\n- **\ud83d\ude80 Multi-Cloud Support**: AWS, OCI, CloudFlare, SSH server management\n- **\ud83d\udcca Rich Progress Bars**: Real-time progress indicators for all long-running operations\n- **\ud83d\udd12 Secure Configuration**: YAML-based configuration with separate secrets management\n- **\ud83c\udf0d Multi-Account/Multi-Region**: Support for multiple cloud accounts and regions\n- **\ud83c\udfa8 Beautiful Output**: Rich terminal output with tables, colors, and formatting\n- **\u26a1 High Performance**: Optimized for speed with concurrent operations\n- **\ud83d\udee1\ufe0f Security First**: Built-in security validation and credential protection\n\n### Supported Services\n\n#### AWS Services (Production Ready)\n- **Compute**: EC2 instances, ECS services, EKS clusters, Fargate\n- **Storage**: S3 buckets, RDS databases\n- **Networking**: VPC, Load Balancers, Security Groups, VPN\n- **Other**: CloudFront distributions, MSK clusters, CodePipeline\n\n#### Oracle Cloud Infrastructure (Production Ready)\n- **Compute**: VM instances, Container Instances\n- **Networking**: VCN, Load Balancers, Network Security Groups\n- **Storage**: Block volumes, Object storage\n- **Management**: Compartments, Policies, Cost analysis\n\n#### CloudFlare (Production Ready)\n- **DNS**: Zone and record management with filtering\n\n#### SSH Management (Production Ready)\n- **Server Discovery**: Automatic server registration and information gathering\n- **Security**: Built-in security filtering and connection management\n\n#### Development Status\n- **\u26a0\ufe0f Azure**: In development - usable but may contain bugs\n- **\u26a0\ufe0f GCP**: In development - usable but may contain bugs\n\n## \ud83d\udce6 Installation\n\n### Prerequisites\n\n- **Python**: 3.9 or higher (3.11.13 recommended)\n- **Operating System**: macOS, Linux, or Windows\n- **Dependencies**: All dependencies are automatically installed via pip\n\n### From PyPI (Recommended)\n\n```bash\n# Install the latest stable version\npip install ic-code\n\n# Verify installation\nic --help\n```\n\n### From Source (Development)\n\n```bash\n# Clone the repository\ngit clone https://github.com/dgr009/ic.git\ncd ic\n\n# Create and activate virtual environment\npython -m venv ic-env\nsource ic-env/bin/activate # On Windows: ic-env\\Scripts\\activate\n\n# Install dependencies\npip install -r requirements.txt\n\n# Install in development mode\npip install -e .\n\n# Verify installation\nic --help\n```\n\n### Dependency Validation\n\nIC CLI automatically validates all required dependencies on startup and provides clear error messages for missing packages. The tool supports **Python 3.9-3.12** with **Python 3.11.13** recommended for optimal performance.\n\n#### Automatic Validation\n```bash\n# IC CLI validates dependencies automatically\nic --help # Will show dependency errors if any exist\n\n# Manual dependency validation\npython scripts/validate_dependencies.py\n\n# Comprehensive compatibility testing\npython scripts/test_dependency_compatibility.py --report\n```\n\n#### Troubleshooting Dependencies\n```bash\n# Check Python version compatibility\npython --version # Should be 3.9+ to 3.12\n\n# Install/update all dependencies\npip install --upgrade -r requirements.txt\n\n# Install missing dependencies automatically\npython scripts/validate_dependencies.py --install-missing\n\n# Test requirements.txt installation\npython scripts/validate_dependencies.py --test-requirements\n\n# Validate specific platform dependencies\npython scripts/validate_dependencies.py --platforms aws oci\n```\n\n#### Supported Python Versions\n- **Python 3.9**: Minimum supported version\n- **Python 3.10**: Fully supported\n- **Python 3.11**: Recommended (tested with 3.11.13)\n- **Python 3.12**: Fully supported\n- **Python 3.13+**: Not yet tested (may work but not guaranteed)\n\n## \u2699\ufe0f Configuration\n\nIC CLI uses a modern, secure YAML-based configuration system that separates default settings from sensitive credentials.\n\n### Quick Setup\n\nThe fastest way to get started is using the built-in configuration initializer:\n\n```bash\n# Initialize configuration with guided setup\nic config init\n\n# This creates:\n# - ~/.ic/config/default.yaml (default settings)\n# - ~/.ic/config/secrets.yaml.example (template for secrets)\n# - Updates .gitignore for security\n```\n\n### Configuration Structure\n\nIC CLI uses a two-file configuration system for security:\n\n```\n~/.ic/config/\n\u251c\u2500\u2500 default.yaml # Non-sensitive default settings\n\u2514\u2500\u2500 secrets.yaml # Your sensitive credentials (create from example)\n```\n\n### Step-by-Step Configuration\n\n#### 1. Initialize Configuration\n\n```bash\n# Create configuration directory and files\nic config init\n\n# For specific cloud platforms\nic config init --template aws # AWS-focused setup\nic config init --template multi-cloud # All platforms\n```\n\n#### 2. Configure Credentials\n\nCopy the example secrets file and add your credentials:\n\n```bash\n# Copy the example file\ncp ~/.ic/config/secrets.yaml.example ~/.ic/config/secrets.yaml\n\n# Edit with your actual credentials\nvim ~/.ic/config/secrets.yaml\n```\n\n#### 3. Example Secrets Configuration\n\n```yaml\n# ~/.ic/config/secrets.yaml\n# AWS Configuration\naws:\n accounts:\n - \"123456789012\" # Your AWS account IDs\n - \"987654321098\"\n profiles:\n default: \"your-aws-profile-name\"\n regions:\n - \"ap-northeast-2\"\n - \"us-east-1\"\n\n# Oracle Cloud Infrastructure\noci:\n config_file: \"~/.oci/config\"\n profile: \"DEFAULT\"\n compartments:\n - \"ocid1.compartment.oc1..example\"\n\n# CloudFlare Configuration \ncloudflare:\n email: \"your-email@example.com\"\n api_token: \"your-cloudflare-api-token\"\n accounts: [\"account1\", \"account2\"] # Filter specific accounts\n zones: [\"example.com\", \"test.com\"] # Filter specific zones\n\n# SSH Configuration\nssh:\n key_dir: \"~/aws-keys\"\n timeout: 30\n skip_prefixes: # Skip servers with these prefixes for security\n - \"git\"\n - \"bastion\"\n - \"jump\"\n - \"proxy\"\n```\n\n#### 4. Platform-Specific Setup\n\n**AWS Credentials:**\n```bash\n# Configure AWS CLI (if not already done)\naws configure\n\n# Or use specific profiles\naws configure --profile production\naws configure --profile development\n```\n\n**OCI Configuration:**\n```bash\n# Install OCI CLI and configure\noci setup config\n\n# Verify configuration\noci iam user get --user-id $(oci iam user list --query 'data[0].id' --raw-output)\n```\n\n**CloudFlare API Token:**\n1. Go to CloudFlare Dashboard \u2192 My Profile \u2192 API Tokens\n2. Create token with Zone:Read permissions\n3. Add token to secrets.yaml\n\n### Configuration Management Commands\n\n```bash\n# Validate configuration\nic config validate\n\n# Show current configuration (sensitive data masked)\nic config show\n\n# Show only AWS configuration\nic config show --aws\n\n# Get specific configuration value\nic config get aws.regions\n\n# Set configuration value\nic config set aws.regions '[\"us-east-1\", \"ap-northeast-2\"]'\n\n# Migrate from old .env configuration\nic config migrate\n```\n\n## \ud83d\ude80 Usage\n\nAll IC CLI commands feature rich progress bars that show real-time progress for long-running operations, making it easy to monitor multi-region and multi-account queries.\n\n### AWS Services\n\n#### Compute Services\n```bash\n# EC2 instances with progress tracking\nic aws ec2 info\nic aws ec2 info --account 123456789012 --regions us-east-1,ap-northeast-2\n\n# ECS services and tasks\nic aws ecs info # List all ECS clusters and services\nic aws ecs service # Detailed service information\nic aws ecs task # Running task information\n\n# EKS clusters and workloads\nic aws eks info # Cluster information\nic aws eks nodes # Node group details\nic aws eks pods # Pod status across clusters\nic aws eks addons # EKS add-on information\nic aws eks fargate # Fargate profile details\n\n# Fargate services\nic aws fargate info # Fargate service information\n```\n\n#### Storage Services\n```bash\n# S3 buckets with tag management\nic aws s3 list_tags # List all S3 buckets with tags\nic aws s3 tag_check # Validate S3 bucket tagging compliance\nic aws s3 info # Detailed S3 bucket information\n\n# RDS databases\nic aws rds info # RDS instance and cluster information\nic aws rds list_tags # RDS resource tags\nic aws rds tag_check # RDS tagging compliance\n```\n\n#### Networking Services\n```bash\n# VPC and networking\nic aws vpc info # VPC, subnet, and gateway information\nic aws vpc list_tags # VPC resource tags\nic aws vpc tag_check # VPC tagging compliance\n\n# Load Balancers\nic aws lb info # Load balancer details\nic aws lb list_tags # Load balancer tags\nic aws lb tag_check # Load balancer tagging compliance\n\n# Security Groups\nic aws sg info # Security group rules and associations\n\n# VPN connections\nic aws vpn info # VPN gateway and connection information\n```\n\n#### Other AWS Services\n```bash\n# CloudFront distributions\nic aws cloudfront info # CloudFront distribution details\n\n# MSK (Managed Streaming for Kafka)\nic aws msk info # MSK cluster information\nic aws msk broker # Kafka broker details\n\n# CodePipeline\nic aws codepipeline build # Build pipeline status\nic aws codepipeline deploy # Deployment pipeline information\n```\n\n### Oracle Cloud Infrastructure (OCI)\n\n#### Compute and Containers\n```bash\n# VM instances across compartments\nic oci vm info # VM instances with detailed information\nic oci vm info --compartment-name \"Production\"\n\n# Container instances\nic oci aci info # Container instance details\n```\n\n#### Networking\n```bash\n# Virtual Cloud Networks\nic oci vcn info # VCN, subnet, and routing information\n\n# Load Balancers\nic oci lb info # Load balancer configurations\n\n# Network Security Groups\nic oci nsg info # NSG rules and associations\n```\n\n#### Storage and Management\n```bash\n# Block and object storage\nic oci volume info # Block volume details\nic oci obj info # Object storage bucket information\n\n# Identity and policies\nic oci policy info # IAM policies and permissions\nic oci policy search # Search policies by criteria\n\n# Cost management\nic oci cost usage # Usage and cost analysis\nic oci cost credit # Credit and billing information\n\n# Compartment management\nic oci compartment info # Compartment hierarchy and details\n```\n\n### CloudFlare DNS Management\n\n```bash\n# DNS records (automatically filtered by configured accounts/zones)\nic cf dns info # All DNS records\nic cf dns info --account prod # Specific account\nic cf dns info --zone example.com # Specific zone\n\n# The command respects your configuration filters for security\n```\n\n### SSH Server Management\n\n```bash\n# Server information with security filtering\nic ssh info # Information about all registered servers\n\n# Auto-discovery (respects skip_prefixes in configuration)\nic ssh reg # Discover and register new SSH servers\n```\n\n### Configuration Management\n\n```bash\n# Configuration setup and validation\nic config init # Initialize configuration\nic config validate # Validate current configuration\nic config show # Display current configuration (masked)\nic config show --aws # Show only AWS configuration\n\n# Configuration migration\nic config migrate # Migrate from .env to YAML configuration\n\n# Configuration management\nic config get aws.regions # Get specific value\nic config set aws.regions '[\"us-east-1\"]' # Set specific value\n```\n\n### Multi-Account and Multi-Region Examples\n\n```bash\n# Query multiple AWS accounts and regions\nic aws ec2 info --account 123456789012,987654321098 --regions us-east-1,ap-northeast-2,eu-west-1\n\n# OCI multi-compartment queries\nic oci vm info --compartment-name \"Production,Development,Testing\"\n\n# All commands show progress bars for long-running operations\n```\n\n## \ud83d\udccb Command Structure\n\nIC CLI follows a consistent, intuitive command structure across all platforms:\n\n```\nic <platform> <service> <command> [options]\n```\n\n### Command Components\n\n- **platform**: `aws`, `oci`, `cf` (CloudFlare), `ssh`, `config`\n- **service**: `ec2`, `s3`, `ecs`, `eks`, `rds`, `vm`, `lb`, `dns`, etc.\n- **command**: `info`, `list_tags`, `tag_check`, etc.\n- **options**: `--account`, `--regions`, `--compartment-name`, etc.\n\n### Common Options\n\nMost commands support these common options:\n\n```bash\n# AWS-specific options\n--account ACCOUNT_ID # Target specific AWS account(s)\n--regions REGION_LIST # Target specific AWS region(s)\n--profile PROFILE_NAME # Use specific AWS profile\n\n# OCI-specific options\n--compartment-name NAME # Target specific OCI compartment(s)\n--region REGION_NAME # Target specific OCI region\n\n# CloudFlare-specific options\n--account ACCOUNT_NAME # Target specific CloudFlare account\n--zone ZONE_NAME # Target specific DNS zone\n\n# Output options (available on most commands)\n--output json # JSON output format\n--output table # Table output format (default)\n--verbose # Detailed output\n--quiet # Minimal output\n```\n\n## \ud83d\udca1 Advanced Examples\n\n### Multi-Cloud Infrastructure Audit\n\n```bash\n# AWS infrastructure overview\nic aws ec2 info --regions us-east-1,ap-northeast-2\nic aws rds info --account 123456789012\nic aws s3 tag_check\n\n# OCI infrastructure overview \nic oci vm info --compartment-name \"Production\"\nic oci lb info\nic oci cost usage\n\n# CloudFlare DNS audit\nic cf dns info --zone production-domain.com\n```\n\n### Security and Compliance Checks\n\n```bash\n# AWS tagging compliance\nic aws ec2 tag_check # Check EC2 instance tagging\nic aws s3 tag_check # Check S3 bucket tagging\nic aws rds tag_check # Check RDS tagging\nic aws lb tag_check # Check Load Balancer tagging\nic aws vpc tag_check # Check VPC resource tagging\n\n# OCI policy and security review\nic oci policy info # Review IAM policies\nic oci nsg info # Review network security groups\n```\n\n### Cost and Resource Management\n\n```bash\n# AWS resource inventory\nic aws ec2 info --regions all # All EC2 instances across regions\nic aws rds info --account all # All RDS instances across accounts\nic aws s3 info # All S3 buckets\n\n# OCI cost analysis\nic oci cost usage # Usage and cost breakdown\nic oci cost credit # Credit and billing status\nic oci compartment info # Resource organization\n```\n\n### Development Status Examples\n\n\u26a0\ufe0f **Note**: Azure and GCP features are in development. While usable, they may contain bugs:\n\n```bash\n# Azure (Development - may have issues)\nic azure --help # Shows development warning\nic azure vm info # Basic VM information\nic azure aks info # AKS cluster details\n\n# GCP (Development - may have issues) \nic gcp --help # Shows development warning\nic gcp compute info # Compute Engine instances\nic gcp gke info # GKE cluster information\n```\n\n## \ud83d\udd27 Troubleshooting\n\n### Common Issues and Solutions\n\n#### Installation Issues\n\n**Problem**: `pip install ic-code` fails with dependency conflicts\n```bash\n# Solution: Use a virtual environment\npython -m venv ic-env\nsource ic-env/bin/activate # On Windows: ic-env\\Scripts\\activate\npip install --upgrade pip\npip install ic-code\n```\n\n**Problem**: Python version compatibility issues\n```bash\n# Check Python version (3.9+ required, 3.11.13 recommended)\npython --version\n\n# Install compatible Python version using pyenv (recommended)\npyenv install 3.11.13\npyenv local 3.11.13\n```\n\n#### Configuration Issues\n\n**Problem**: `ic config validate` shows validation errors\n```bash\n# Check configuration file syntax\nic config show --verbose\n\n# Reinitialize configuration\nic config init --force\n\n# Migrate from old .env configuration\nic config migrate\n```\n\n**Problem**: AWS credentials not found\n```bash\n# Configure AWS CLI\naws configure\n\n# Verify AWS credentials\naws sts get-caller-identity\n\n# Check IC configuration\nic config show --aws\n```\n\n**Problem**: OCI configuration issues\n```bash\n# Verify OCI CLI configuration\noci setup config\n\n# Test OCI connectivity\noci iam user get --user-id $(oci iam user list --query 'data[0].id' --raw-output)\n\n# Check IC OCI configuration\nic config get oci.config_file\n```\n\n#### Runtime Issues\n\n**Problem**: Commands hang or timeout\n```bash\n# Check network connectivity\nping aws.amazon.com\nping oracle.com\n\n# Increase timeout in configuration\nic config set aws.timeout 60\nic config set oci.timeout 60\n```\n\n**Problem**: Permission denied errors\n```bash\n# Check file permissions\nls -la ~/.ic/config/\n\n# Fix permissions\nchmod 600 ~/.ic/config/secrets.yaml\nchmod 755 ~/.ic/config/\n```\n\n**Problem**: Progress bars not displaying correctly\n```bash\n# Check terminal compatibility\necho $TERM\n\n# Force simple output if needed\nexport IC_SIMPLE_OUTPUT=1\nic aws ec2 info\n```\n\n#### Platform-Specific Issues\n\n**AWS Issues:**\n- Ensure AWS CLI is configured: `aws configure`\n- Check account access: `aws sts get-caller-identity`\n- Verify region availability: `aws ec2 describe-regions`\n\n**OCI Issues:**\n- Verify OCI CLI setup: `oci setup config`\n- Check compartment access: `oci iam compartment list`\n- Validate API key: `oci iam user get --user-id <user-id>`\n\n**CloudFlare Issues:**\n- Verify API token permissions in CloudFlare dashboard\n- Check zone access: Test with CloudFlare API directly\n- Ensure account/zone filters are correct in configuration\n\n### Getting Help\n\n```bash\n# General help\nic --help\n\n# Platform-specific help\nic aws --help\nic oci --help\nic cf --help\n\n# Service-specific help\nic aws ec2 --help\nic oci vm --help\n\n# Configuration help\nic config --help\n```\n\n### Debug Mode\n\nEnable verbose logging for troubleshooting:\n\n```bash\n# Set debug logging level\nic config set logging.level DEBUG\n\n# Run command with verbose output\nic aws ec2 info --verbose\n\n# Check log files\ntail -f ~/.ic/logs/ic.log\n```\n\n## \ud83d\udea7 Development Status\n\n### Production Ready Platforms\n- \u2705 **AWS**: Fully tested and production ready\n- \u2705 **OCI**: Fully tested and production ready \n- \u2705 **CloudFlare**: Fully tested and production ready\n- \u2705 **SSH**: Fully tested and production ready\n\n### Development Platforms\n- \u26a0\ufe0f **Azure**: In active development\n - Basic functionality implemented\n - May contain bugs or incomplete features\n - Use with caution in production environments\n - Help shows development status warning: `ic azure --help`\n\n- \u26a0\ufe0f **GCP**: In active development\n - Basic functionality implemented\n - May contain bugs or incomplete features\n - Use with caution in production environments\n - Help shows development status warning: `ic gcp --help`\n\n### Reporting Issues\n\nIf you encounter issues with development platforms:\n\n1. Check the help output for known limitations: `ic azure --help` or `ic gcp --help`\n2. Enable debug logging: `ic config set logging.level DEBUG`\n3. Report issues with detailed logs on [GitHub Issues](https://github.com/dgr009/ic/issues)\n4. Include platform, service, and command details in your report\n\n## \ud83c\udfd7\ufe0f Development\n\n### Project Structure\n\n```\nic/\n\u251c\u2500\u2500 src/ic/ # Main package\n\u2502 \u251c\u2500\u2500 cli.py # CLI entry point and argument parsing\n\u2502 \u251c\u2500\u2500 config/ # Configuration management system\n\u2502 \u251c\u2500\u2500 core/ # Core utilities and logging\n\u2502 \u2514\u2500\u2500 commands/ # Command implementations\n\u251c\u2500\u2500 aws/ # AWS service modules\n\u251c\u2500\u2500 oci_module/ # Oracle Cloud Infrastructure modules\n\u251c\u2500\u2500 cf/ # CloudFlare modules\n\u251c\u2500\u2500 ssh/ # SSH management modules\n\u251c\u2500\u2500 azure_module/ # Azure modules (development)\n\u251c\u2500\u2500 gcp/ # Google Cloud Platform modules (development)\n\u251c\u2500\u2500 common/ # Shared utilities and progress decorators\n\u251c\u2500\u2500 tests/ # Test suite\n\u2502 \u251c\u2500\u2500 unit/ # Unit tests\n\u2502 \u251c\u2500\u2500 integration/ # Integration tests\n\u2502 \u2514\u2500\u2500 security/ # Security tests\n\u251c\u2500\u2500 docs/ # Documentation\n\u251c\u2500\u2500 requirements.txt # Python dependencies\n\u2514\u2500\u2500 pyproject.toml # Package configuration\n```\n\n### Setting Up Development Environment\n\n```bash\n# Clone repository\ngit clone https://github.com/dgr009/ic.git\ncd ic\n\n# Create virtual environment\npython -m venv ic-dev\nsource ic-dev/bin/activate # On Windows: ic-dev\\Scripts\\activate\n\n# Install development dependencies\npip install -r requirements.txt\npip install -e .[dev]\n\n# Run tests\npytest\n\n# Run with coverage\npytest --cov=src --cov-report=html\n```\n\n### Adding New Services\n\n1. **Create service module**: Add new module in appropriate platform directory\n2. **Implement progress decorators**: Use `@progress_bar_decorator` for long operations\n3. **Add CLI integration**: Update `src/ic/cli.py` with new commands\n4. **Add tests**: Create unit and integration tests\n5. **Update documentation**: Add usage examples to README\n\n### Testing\n\n```bash\n# Run all tests\npytest\n\n# Run specific test categories\npytest -m unit # Unit tests only\npytest -m integration # Integration tests only\npytest -m security # Security tests only\n\n# Run with coverage\npytest --cov=src --cov-report=html --cov-report=term\n\n# Run performance tests\npytest -m performance\n```\n\n## \ud83e\udd1d Contributing\n\nWe welcome contributions! Please see our contribution guidelines:\n\n1. **Fork the repository** on GitHub\n2. **Create a feature branch**: `git checkout -b feature/amazing-feature`\n3. **Make your changes** with appropriate tests\n4. **Run the test suite**: `pytest`\n5. **Update documentation** as needed\n6. **Submit a pull request** with a clear description\n\n### Code Standards\n\n- Follow PEP 8 style guidelines\n- Add type hints for new functions\n- Include docstrings for public methods\n- Add progress bar decorators for long-running operations\n- Ensure security best practices for credential handling\n\n## \ud83d\udcc4 License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n\n## \ud83c\udd98 Support\n\n- **Documentation**: This README and inline help (`ic --help`)\n- **Issues**: [GitHub Issues](https://github.com/dgr009/ic/issues)\n- **Discussions**: [GitHub Discussions](https://github.com/dgr009/ic/discussions)\n- **Security**: Report security issues privately via GitHub Security Advisories\n\n---\n\n**Made with \u2764\ufe0f for infrastructure engineers and cloud administrators**$`\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Infrastructure CLI tool for managing AWS, CloudFlare, SSH, and more",
"version": "1.0.5",
"project_urls": {
"Bug Reports": "https://github.com/dgr009/ic/issues",
"Documentation": "https://github.com/dgr009/ic#readme",
"Homepage": "https://github.com/dgr009/ic",
"Source": "https://github.com/dgr009/ic"
},
"split_keywords": [
"cli",
" infrastructure",
" aws",
" oci",
" gcp",
" azure",
" cloudflare",
" ssh",
" devops",
" multi-cloud"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e2d13ebc23bda34bc32a08c77e07d11177a574c5199e6649d42c09ded0cecc59",
"md5": "095d87e275bf4416bc75ecd592fddf6c",
"sha256": "2b223244164c5a643aba71fe3bcb351e35d1c7f1cec9ef65a641a845171bacdb"
},
"downloads": -1,
"filename": "ic_code-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "095d87e275bf4416bc75ecd592fddf6c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 106579,
"upload_time": "2025-09-10T10:17:18",
"upload_time_iso_8601": "2025-09-10T10:17:18.150708Z",
"url": "https://files.pythonhosted.org/packages/e2/d1/3ebc23bda34bc32a08c77e07d11177a574c5199e6649d42c09ded0cecc59/ic_code-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "0d9f01ab04bded76c60c5c1db7cafddfa19f0b1de3669561b7f6504e4e4e7189",
"md5": "bfc392d5de6190c7f9b1bb13204fbbe8",
"sha256": "15a423c9b6264bb5a92102868bec67ea17da350a261cdae70d3ee19c0594b0d2"
},
"downloads": -1,
"filename": "ic_code-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "bfc392d5de6190c7f9b1bb13204fbbe8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 401244,
"upload_time": "2025-09-10T10:17:19",
"upload_time_iso_8601": "2025-09-10T10:17:19.442037Z",
"url": "https://files.pythonhosted.org/packages/0d/9f/01ab04bded76c60c5c1db7cafddfa19f0b1de3669561b7f6504e4e4e7189/ic_code-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-10 10:17:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dgr009",
"github_project": "ic",
"github_not_found": true,
"lcname": "ic-code"
}
JSON
