CLI Installation & update¶
The VDC CLI is a cross-platform command-line tool that provides programmatic access to VDC functionality. This guide covers installation, verification, and maintenance of the CLI.
System Requirements¶
- Windows: Windows 10 or later, PowerShell 5.1 or later
- Linux: Most modern distributions with bash
Installation¶
Windows Installation¶
PowerShell (Recommended)¶
$ProgressPreference = "SilentlyContinue"; (Invoke-WebRequest -Uri 'https://af01p-fm.devtools.intel.com/artifactory/vdc-client-fm-local/vdc/cli/prod/win-x64/vdc.exe' -OutFile '.\vdc.exe') | Out-Null; .\vdc.exe install; rm .\vdc.exe
Manual Installation¶
-
Download the CLI executable:
-
Install to system PATH:
-
Clean up:
Linux Installation¶
One-Line Installation¶
wget https://af01p-fm.devtools.intel.com/artifactory/vdc-client-fm-local/vdc/cli/prod/linux-x64/vdc && chmod +x vdc && sudo ./vdc install && rm vdc
Manual Installation¶
-
Download the CLI binary:
-
Make executable:
-
Install to system PATH:
-
Clean up:
Verification¶
Check Installation¶
# Verify CLI is installed and accessible
vdc --version
# Expected output:
# Validation DevOps Center CLI 1.0.0
Test Basic Functionality¶
# Show help to verify CLI is working
vdc --help
# Test connectivity (requires authentication)
vdc ingredient get --help
Updates¶
The VDC API evolves continuously, and CLI compatibility is only guaranteed with recent versions.
Automatic Updates¶
The CLI includes a built-in update mechanism:
Update Process¶
- Check Version: CLI compares local version with latest available
- Download: If newer version exists, downloads automatically
- Install: Replaces current installation with new version
- Verify: Confirms successful update
Update Best Practices¶
- Regular Updates: Run
vdc update
monthly or before major automation deployments - Test Updates: Test CLI updates in non-production environments first
- Pin Versions: For CI/CD systems, consider pinning to specific versions for stability
Next Steps¶
After Installation¶
- Set Up Authentication - Configure tokens for VDC access
- Try First Steps - Execute your first VDC CLI commands
- Learn Basic Workflows - Common usage patterns
For Automation¶
- CI/CD Integration - Integrate into pipelines
- Bulk Operations - Advanced batch processing
- Error Handling - Robust automation patterns
Related Documentation¶
- CLI Authentication - Token setup and security
- Quick Reference - Essential commands
- Troubleshooting - Common issues and solutions