Internal Developer Platform CLI โ Complete self-service infrastructure with service management, security scanning, cost optimization, and API documentation
Project description
๐ Internal Developer Platform (IDP) CLI
A powerful CLI tool that enables self-service infrastructure, service creation, and complete operational management for developers, following modern Platform Engineering principles.
The IDP CLI automates the creation of production-ready services by generating repositories, CI/CD pipelines, Kubernetes deployments, and observability integrations โ enabling developers to bootstrap new services in seconds.
NEW in v1.0.0: Complete enterprise-grade platform with security scanning, cost management, and API documentation - the definitive internal developer platform solution.
๐ฏ Problem
In many organizations, creating and managing services requires multiple manual steps:
- Requesting a repository and setting up CI/CD pipelines
- Writing Dockerfiles and Kubernetes manifests
- Configuring monitoring and alerts
- Managing service lifecycle across environments
- Promoting services through deployment pipelines
- Monitoring service health and SLA compliance
- Understanding service dependencies and deployment order
This process slows down development and increases operational overhead. Additionally, service lifecycle management, environment promotion, and comprehensive health monitoring remain challenging tasks for platform teams.
๐ก Solution
The Internal Developer Platform CLI provides a complete self-service developer platform where engineers can create, manage, and operate fully configured services with simple commands.
Example:
# Create a new service
idp-cli create-service payment-service --template python-api
# Manage service lifecycle
idp-cli service list --environment prod
idp-cli service restart user-service --environment staging
idp-cli service logs payment-service --follow
# Promote services through environments
idp-cli env promote payment-service --from dev --to staging
# Monitor comprehensive health with SLA tracking
idp-cli health --service payment-service --detailed --trends 24
This automatically generates and manages:
- Service repository with application code
- CI/CD pipeline (GitHub Actions / GitLab CI / Jenkins)
- Docker configuration (multi-stage, non-root)
- Kubernetes deployment manifests (with Kustomize overlays)
- Environment configuration (dev / staging / production)
- Monitoring setup (Prometheus rules, Grafana dashboards)
- Documentation templates (README, deployment guide, architecture)
- Service lifecycle operations (list, info, restart, logs)
- Environment promotion workflows with policy checks
- Advanced health monitoring with SLA compliance tracking
โจ Features
๐ง Service Scaffolding
Generate production-ready microservices using prebuilt templates.
๐ Backend APIs
| Template | Description | Language | Framework |
|---|---|---|---|
python-api |
Production-ready Python API service | Python | FastAPI |
node-api |
Production-ready Node.js API service | JavaScript | Express |
go-api |
Production-ready Go API service | Go | Gin |
rust-api |
High-performance Rust API service | Rust | Axum |
python-graphql |
GraphQL API with Strawberry and FastAPI | Python | Strawberry |
ml-inference |
Machine learning model inference API | Python | FastAPI |
๐จ Frontend Applications
| Template | Description | Language | Framework |
|---|---|---|---|
react-frontend |
React frontend with TypeScript and Vite | TypeScript | React |
nextjs-fullstack |
Full-stack application with Next.js | TypeScript | Next.js |
static-site |
Modern static site with HTML, CSS, JS | JavaScript | Vanilla |
๐ ๏ธ Developer Tools
| Template | Description | Language | Framework |
|---|---|---|---|
python-cli |
Command-line tool with Click and Rich | Python | Click |
worker |
Background worker/job processing service | Python | Celery |
โ๏ธ CI/CD Automation
Automatically include CI/CD pipelines for new services.
| Provider | Pipeline Includes |
|---|---|
github-actions |
Build, Test, Security scan, Docker build, Deploy |
gitlab-ci |
Lint, Test, Security, Build, Deploy (staging + production) |
jenkins |
Checkout, Lint, Test, Security, Docker build/push, Deploy |
๐ณ Containerization
Automatically generate optimized Docker configurations:
- Multi-stage builds
- Secure base images
- Non-root containers
- Health checks
โธ๏ธ Kubernetes Deployment
Generate Kubernetes manifests with Kustomize overlays:
- Deployments with resource limits
- Services (ClusterIP)
- ConfigMaps
- Horizontal Pod Autoscaler
- Liveness, readiness, and startup probes
- Environment-specific overlays (dev/staging/production)
๐ GitOps Integration
Supports GitOps workflows:
| Tool | Generated Artifacts |
|---|---|
argocd |
Application manifests per environment, AppProject |
flux |
GitRepository source, Kustomization per environment |
๐ Observability Integration
Automatically configure monitoring:
- Prometheus alerting rules (error rate, latency, pod restarts)
- ServiceMonitor for Prometheus Operator
- Grafana dashboard template (request rate, latency, errors, CPU, memory)
๐งฉ Multi-Environment Support
Environment-specific configuration via Kustomize overlays:
| Environment | Replicas | CPU Limit | Memory Limit |
|---|---|---|---|
dev |
1 | 250m | 256Mi |
staging |
2 | 500m | 512Mi |
production |
3 | 1000m | 1Gi |
๐ Service Lifecycle Management
Complete operational control over your deployed services.
# List all services with filtering
idp-cli service list --environment prod --team backend
# Get detailed service information
idp-cli service info payment-service --environment staging
# Restart services with readiness checks
idp-cli service restart user-service --environment prod --wait
# Stream service logs in real-time
idp-cli service logs worker-service --follow --tail 100
๐ Environment Management & Promotion
Manage environments and promote services with policy-based workflows.
# List all environments with health statistics
idp-cli env list
# Create new environments from existing ones
idp-cli env create staging --base dev
# Promote services with policy checks
idp-cli env promote payment-service --from dev --to staging
# Compare environments and detect differences
idp-cli env diff staging production
# Dry-run promotion to validate policies
idp-cli env promote user-service --from staging --to prod --dry-run
๐ฅ Advanced Health Monitoring & SLA Tracking
Comprehensive health monitoring with performance metrics and SLA compliance.
# Monitor all services in an environment
idp-cli health --environment prod
# Detailed health analysis with SLA checks
idp-cli health --service payment-service --detailed
# Real-time health monitoring dashboard
idp-cli health --watch --interval 15
# Analyze health trends over time
idp-cli health --service user-service --trends 24
# Performance metrics and resource usage
idp-cli health --service payment-service --detailed --environment prod
๏ฟฝ Security Scanning
Comprehensive security vulnerability management for containers and source code.
# Scan container image for vulnerabilities
idp-cli security scan payment-service:latest --scanner trivy
# Scan source code with Snyk
idp-cli security scan ./src --type code --scanner snyk
# Check against security policies
idp-cli security scan payment-service:latest --policy-check
# Manage security policies
idp-cli security policy --set critical:0 --set high:1
# View scan history
idp-cli security history --image payment-service:latest
๐ฐ Cost Management
Complete cloud cost visibility and resource optimization.
# Generate comprehensive cost report
idp-cli cost report --environment prod
# Analyze resource usage for optimization
idp-cli cost usage payment-service --environment staging
# Scale services with cost impact analysis
idp-cli cost scale user-service --replicas 3
# Get cost optimization recommendations
idp-cli cost optimize --environment prod
๐ API Documentation
Automatic API discovery, documentation generation, and testing.
# Discover API endpoints for services
idp-cli api discover payment-service --environment prod
# Generate OpenAPI specification
idp-cli api docs user-service --format openapi
# Generate Markdown documentation
idp-cli api docs payment-service --format markdown --output api-docs.md
# Test API endpoints
idp-cli api test payment-service /health
# List all discovered APIs
idp-cli api list --environment prod
๐ Service Dependency Visualization
Understand service relationships and identify potential issues like circular dependencies.
# Show dependency tree
idp-cli deps --environment dev --format tree
# Show dependency table with deployment order
idp-cli deps --format table --deployment-order
# Generate Mermaid diagram for documentation
idp-cli deps --format mermaid
# Check for circular dependencies
idp-cli deps --check-cycles
๐ Environment Status Check
Verify that your environment infrastructure is ready for deployments.
# Check all environment components
idp-cli env-status --environment dev
# Check specific component only
idp-cli env-status --component kubernetes --detailed
# Check production environment readiness
idp-cli env-status --environment production
๐ Documentation Generation
Auto-generated documentation:
README.mdโ Quick start, project structure, next stepsdocs/deployment.mdโ Deployment guide for all environmentsdocs/architecture.mdโ Architecture overview and design principles
๐ฏ Template Coverage
The IDP CLI supports 11 production-ready templates covering the entire modern development stack:
| Category | Templates | Use Cases |
|---|---|---|
| Backend APIs (6) | python-api, node-api, go-api, rust-api, python-graphql, ml-inference |
Microservices, APIs, GraphQL, ML services |
| Frontend Apps (3) | react-frontend, nextjs-fullstack, static-site |
SPAs, full-stack apps, marketing sites |
| Developer Tools (2) | python-cli, worker |
CLI tools, background jobs, task processing |
Each template includes:
- โ Production-ready code with best practices
- โ Comprehensive testing setup
- โ Docker configuration (multi-stage, secure)
- โ Kubernetes manifests with HPA
- โ CI/CD pipelines (GitHub/GitLab/Jenkins)
- โ Monitoring and observability
- โ Environment-specific configs
- โ Complete documentation
๐ฆ Installation
pip install idp-cli
Or install from source:
git clone https://github.com/NotHarshhaa/internal-developer-platform-cli.git
cd internal-developer-platform-cli
pip install -e .
Latest Version: v1.0.0 (complete enterprise-grade platform with security, cost, and API management)
๐ฅ๏ธ Usage
Create a Service
# Python API service
idp-cli create-service payment-service --template python-api
# Go API service
idp-cli create-service user-service --template go-api
# React frontend
idp-cli create-service web-app --template react-frontend
# Rust API service
idp-cli create-service auth-service --template rust-api
Create Service with Full Options
# Full-stack Next.js application with complete CI/CD
idp-cli create-service my-app \
--template nextjs-fullstack \
--ci github-actions \
--deploy kubernetes \
--gitops argocd \
--output-dir ./services
# High-performance Go API with GitLab CI
idp-cli create-service api-gateway \
--template go-api \
--ci gitlab-ci \
--deploy kubernetes
List Available Templates
idp-cli list-templates
Service Management
# List all services with filtering
idp-cli service list --environment prod --team backend
# Get detailed service information
idp-cli service info payment-service --environment staging
# Restart services with readiness checks
idp-cli service restart user-service --environment prod --wait
# Stream service logs in real-time
idp-cli service logs worker-service --follow --tail 100
Environment Management
# List all environments with health statistics
idp-cli env list
# Create new environments from existing ones
idp-cli env create staging --base dev
# Promote services with policy checks
idp-cli env promote payment-service --from dev --to staging
# Compare environments and detect differences
idp-cli env diff staging production
# Dry-run promotion to validate policies
idp-cli env promote user-service --from staging --to prod --dry-run
Health Monitoring
# Check all services in dev environment
idp-cli health --environment dev
# Monitor specific service continuously
idp-cli health --service payment-api --watch --interval 30
# Detailed health analysis with SLA tracking
idp-cli health --service payment-service --detailed --trends 24
Visualize Service Dependencies
# Show dependency tree
idp-cli deps --environment dev
# Check for circular dependencies and show deployment order
idp-cli deps --check-cycles --deployment-order
Check Environment Status
# Check all environment components
idp-cli env-status --environment dev
# Check specific component with details
idp-cli env-status --component kubernetes --detailed
Skip Optional Components
idp-cli create-service my-service \
--template python-api \
--no-docker \
--no-k8s \
--no-monitoring \
--no-docs
Get Help
idp-cli --help
idp-cli create-service --help
idp-cli service --help
idp-cli env --help
idp-cli health --help
idp-cli security --help
idp-cli cost --help
idp-cli api --help
idp-cli deps --help
idp-cli env-status --help
๐ง Architecture Overview
The IDP CLI follows Platform Engineering principles by providing a standardized developer experience.
Developer Request
โ
IDP CLI (Click)
โ
โโโโโโโโโโโโโโโโโโโโโ
โ Template Registry โ โ Service code scaffolding
โโโโโโโโโโโโโโโโโโโโโค
โ CI/CD Generator โ โ GitHub Actions / GitLab CI / Jenkins
โโโโโโโโโโโโโโโโโโโโโค
โ Docker Generator โ โ Multi-stage Dockerfile + .dockerignore
โโโโโโโโโโโโโโโโโโโโโค
โ K8s Generator โ โ Deployments, Services, ConfigMaps, HPA
โโโโโโโโโโโโโโโโโโโโโค
โ GitOps Generator โ โ ArgoCD / Flux manifests
โโโโโโโโโโโโโโโโโโโโโค
โ Monitoring Gen โ โ Prometheus rules, Grafana dashboards
โโโโโโโโโโโโโโโโโโโโโค
โ Security Scanner โ โ Container and source code vulnerability scanning
โโโโโโโโโโโโโโโโโโโโโค
โ Cost Manager โ โ Cloud cost analysis and resource optimization
โโโโโโโโโโโโโโโโโโโโโค
โ API Documentation โ โ API discovery, documentation generation, and testing
โโโโโโโโโโโโโโโโโโโโโค
โ Service Manager โ โ Service lifecycle operations (list, info, restart, logs)
โโโโโโโโโโโโโโโโโโโโโค
โ Environment Managerโ โ Environment promotion and management
โโโโโโโโโโโโโโโโโโโโโค
โ Health Monitor โ โ Service health checks and monitoring
โโโโโโโโโโโโโโโโโโโโโค
โ Dependency Analyzerโ โ Service relationships and deployment order
โโโโโโโโโโโโโโโโโโโโโค
โ Environment Checkerโ โ Infrastructure readiness validation
โโโโโโโโโโโโโโโโโโโโโค
โ Docs Generator โ โ README, deployment guide, architecture
โโโโโโโโโโโโโโโโโโโโโ
๐งช Development
# Clone the repository
git clone https://github.com/NotHarshhaa/internal-developer-platform-cli.git
cd internal-developer-platform-cli
# Install in development mode
pip install -e ".[dev]"
# Run tests
pytest -v
# Run tests with coverage
pytest --cov=idp_cli --cov-report=html -v
# Lint
ruff check idp_cli/
# Format
black idp_cli/ tests/
๐ฏ Goals
- Enable self-service infrastructure
- Standardize service creation
- Reduce DevOps bottlenecks
- Improve developer experience (DevEx)
- Promote platform engineering practices
- Provide complete service lifecycle management
- Enable environment promotion workflows with policy checks
- Provide advanced health monitoring with SLA tracking
- Offer comprehensive security vulnerability scanning
- Deliver cloud cost visibility and optimization
- Provide automatic API documentation and testing
- Automate platform operations and reduce manual overhead
๐จโ๐ป Who Is This For?
- Platform Engineers
- DevOps Engineers
- Cloud Engineers
- SRE teams
- Engineering organizations building Internal Developer Platforms
๏ฟฝ Changelog
๐บ๏ธ Roadmap
โ Completed Features
- Service scaffolding with 11 production-ready templates
- CI/CD pipeline generation (GitHub Actions, GitLab CI, Jenkins)
- Docker configuration with multi-stage builds
- Kubernetes deployment manifests with Kustomize
- GitOps integration (ArgoCD, Flux)
- Monitoring setup (Prometheus, Grafana)
- Documentation generation
- Multi-environment support
- Service health monitoring
- Service dependency visualization
- Environment status checking
- Service lifecycle management (list, info, restart, logs)
- Environment promotion workflows with policy checks
- Advanced health monitoring with SLA tracking
- Security vulnerability scanning (Trivy, Snyk integration)
- Cloud cost management and resource optimization
- API documentation generation and testing
๐ Future Enhancements
- Service catalog integration
- Policy as Code support
- Infrastructure provisioning (Terraform)
- Web portal interface
- Plugin architecture
- Secrets management integration
- Custom template support
๐ License
MIT License โ see LICENSE for details.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file idp_cli-1.0.0.tar.gz.
File metadata
- Download URL: idp_cli-1.0.0.tar.gz
- Upload date:
- Size: 140.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
190f4db93914456c66325c95e393834bdca25dbb5c322fbc4682d62f79f3349a
|
|
| MD5 |
2e88b019f6af8c6cee4fc4623a8a86f5
|
|
| BLAKE2b-256 |
1af18d0d27091586c4ff6cedcfb3961969162252fd05fed6dd1471c660590f06
|
File details
Details for the file idp_cli-1.0.0-py3-none-any.whl.
File metadata
- Download URL: idp_cli-1.0.0-py3-none-any.whl
- Upload date:
- Size: 149.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0ecdc0a4e60f6894ac9ff3c0007d24033f573efca28288403944878c92973a95
|
|
| MD5 |
5c730ddd6f2cc7541a2d532a6ac5cb1e
|
|
| BLAKE2b-256 |
ff986ca042cc5573f9db3b2dc99ac0e4823552f48cdb4fa561e31eb5511b814d
|