Guides¶
Step-by-step guides for common workflows and use cases with Devo CLI.
Getting Started¶
AWS Setup¶
Configure AWS credentials and permissions for Devo CLI.
Topics covered:
- Installing AWS CLI
- Configuring credentials
- AWS SSO setup
- Required IAM permissions
- Bedrock model access
- Using AWS profiles
Best for: First-time setup and AWS configuration.
AWS Login Workflow¶
Complete workflow guide for managing AWS SSO authentication.
Topics covered:
- First-time SSO setup
- Daily credential management
- Multi-environment configuration
- Troubleshooting common issues
Best for: Teams using AWS SSO who want to streamline authentication and credential management.
Shell Completion¶
Enable tab completion for your shell.
Topics covered:
- Bash completion
- Zsh completion
- Fish completion
- Installation and configuration
Best for: Improving command-line productivity.
Development Workflows¶
Commit Workflow¶
Learn how to generate conventional commit messages using AI.
Topics covered:
- Staging changes
- Generating commit messages
- Commit message format and types
- Ticket number extraction
- Complete development workflow
Best for: Developers who want to standardize commit messages and automate message generation.
Code Review Workflow¶
Learn how to use AI-powered code review to analyze changes before committing.
Topics covered:
- Running code reviews
- Understanding review categories
- Addressing feedback
- Pre-commit review workflow
- Review specific commits or branches
Best for: Teams implementing code quality checks and security reviews.
AWS Services¶
CodeArtifact Login¶
Authenticate with AWS CodeArtifact to access private npm packages.
Topics covered:
- First-time setup and configuration
- Daily token refresh workflow
- Multiple domains
- Team configuration sharing
- Troubleshooting
Best for: Developers who need to install private npm packages from AWS CodeArtifact.
DynamoDB Export¶
Export DynamoDB table data for backup, analysis, and migration.
Topics covered:
- Export formats (CSV, JSON, JSONL, TSV)
- Handling nested data
- Filtering and querying
- Performance optimization
- Using templates
- Team workflows
Best for: Data engineers and developers working with DynamoDB data.
SSM Port Forwarding¶
Securely connect to private databases and services using AWS Systems Manager.
Topics covered:
- Setting up hostname forwarding
- Connecting to databases
- Multi-environment setup
- Team configuration sharing
- Platform-specific setup (Linux, macOS, Windows)
- Troubleshooting connections
Best for: Developers accessing private RDS, ElastiCache, or other AWS resources.
Quick Links¶
For New Users¶
- AWS Setup - Configure credentials
- AWS Login Workflow - Setup SSO authentication
- Commit Workflow - Start using AI commit messages
- Shell Completion - Enable tab completion
For Teams¶
- AWS Login Workflow - Standardize AWS authentication
- Code Review Workflow - Implement code reviews
- CodeArtifact Login - Share private npm package access
- SSM Port Forwarding - Share database configurations
- DynamoDB Export - Automate data exports
For AWS Users¶
- AWS Setup - Configure AWS access
- AWS Login Workflow - Manage SSO credentials
- CodeArtifact Login - Access private npm packages
- DynamoDB Export - Work with DynamoDB
- SSM Port Forwarding - Access private resources
Related Documentation¶
- Commands Reference - Technical command documentation
- Configuration Guide - Detailed configuration options
- Troubleshooting - Common issues and solutions