CLI Overview & Installation¶
The VDC CLI is a powerful command-line tool that provides programmatic access to most VDC functionality. Whether you're automating CI/CD pipelines, scripting batch operations, or integrating VDC into your development workflow, the CLI offers a fast and reliable way to interact with ingredients, releases, and workflows.
Why Use VDC CLI?¶
For Automation¶
- CI/CD Integration: Seamlessly integrate ingredient submission and download into build pipelines
- Batch Operations: Process multiple ingredients or releases with scripts
- Event-Driven Workflows: Trigger actions based on release events
For Developers¶
- Local Development: Download dependencies directly to your development environment
- Testing: Quickly access different versions of ingredients for validation
- Scripting: Automate repetitive VDC tasks with shell scripts
For DevOps Teams¶
- Infrastructure as Code: Manage VDC operations through version-controlled scripts
- Monitoring: Query ingredient and workflow status programmatically
- Cross-Platform: Works consistently across Windows, Linux, and macOS
Command Categories¶
Category | Commands | Purpose |
---|---|---|
Installation & Updates | install , update |
CLI management |
Authentication | token create |
Token management |
Ingredients | ingredient get , ingredient create |
Ingredient management |
Releases | ingredient-release submit , ingredient-release get , ingredient-release download , ingredient-release bulk-submit |
Release operations |
Workflows | workflow get , workflow-run get , workflow-run-build-step |
Workflow management |
Build Tools | ifwi-build |
Specialized build operations |
Aliases | download , submit |
Common operation shortcuts |
Next Steps¶
New to VDC CLI?¶
- Set up authentication - Configure tokens for secure access
- Learn Release commands- Master the most common operations
- Try Ingredient Commands- Explore ingredient management
Related Documentation¶
- Global search- Finding ingredients and releases in the UI
- Release submission Web-based submission process
- Understanding Ingredients Core VDC concepts