Settings
DFX Dashboard configuration and environment management - DFX version selection, shell completion setup, environment variables, and cache management
The Settings page allows you to customize your DFX Dashboard environment and manage important DFX-related configurations, including automated shell completion setup and comprehensive cache management. This centralized configuration hub ensures optimal development workflow and system performance.
Overview
The Settings page is organized into four main configuration tabs designed for comprehensive environment management:
Version Manager
DFX version selection between bundled and system installations
Cache Management
DFX version cache management and installation control
Environment Variables
DFX environment variables configuration and management
Shell Completion
Automated dfx command completion setup for enhanced productivity
Configuration Management
Version Manager Tab
The Version Manager tab provides comprehensive DFX version management capabilities, allowing you to switch between bundled and system DFX installations.
DFX Version Selection
Bundled DFX
Utilizes dfx v0.25.0 that comes packaged with the DFX Dashboard app
System DFX
Uses the DFX version installed on your system via dfxvm
Bundled DFX Features
Installing New Versions
The Version Manager allows you to install new DFX versions directly from the interface:
Select Version
Choose from available DFX versions in the dropdown
Install
Click “Install” to download and install the selected version
Monitor Progress
Track installation progress with the progress indicator
Set as Default
Optionally set the newly installed version as default
The bundled DFX option allows you to use the Dashboard even if dfx is not installed on your system, which can be useful for quick setups or testing. The current system dfx version is displayed next to the toggle (e.g., “dfx 0.25.0”).
Version Manager Tab
The Version Manager tab provides comprehensive DFX version management capabilities, allowing you to switch between bundled and system DFX installations.
DFX Version Selection
Bundled DFX
Utilizes dfx v0.25.0 that comes packaged with the DFX Dashboard app
System DFX
Uses the DFX version installed on your system via dfxvm
Bundled DFX Features
Installing New Versions
The Version Manager allows you to install new DFX versions directly from the interface:
Select Version
Choose from available DFX versions in the dropdown
Install
Click “Install” to download and install the selected version
Monitor Progress
Track installation progress with the progress indicator
Set as Default
Optionally set the newly installed version as default
The bundled DFX option allows you to use the Dashboard even if dfx is not installed on your system, which can be useful for quick setups or testing. The current system dfx version is displayed next to the toggle (e.g., “dfx 0.25.0”).
Cache Management Tab
The Cache Management tab provides comprehensive control over your DFX version cache, allowing you to manage disk space and installed versions efficiently.
Cache Overview
Cache Directory
View the location of your DFX cache directory
Total Size
Monitor total disk space used by cached versions
Version Count
Track the number of cached DFX versions
Cache Management Features
Be careful when clearing cache versions, especially active ones. Removing the active version may cause issues with current projects. Always ensure you have the necessary versions available before clearing cache.
Environment Variables Tab
The Environment Variables tab allows you to view and update important DFX environment variables that control various aspects of your development environment.
Variable Categories
Updating Environment Variables
Select Variable
Click the Update button next to the variable you wish to modify
Enter New Value
Enter the new value in the prompt that appears
Confirm Change
Confirm the change to apply the new setting
Verify Application
Restart terminal or dashboard if needed for changes to take effect
These changes affect your DFX environment. Ensure you understand the implications before making changes, as incorrect settings can impact your project’s functionality. Use absolute paths for path-related variables to avoid ambiguity.
Shell Completion Setup
The Shell Completion tab provides automated setup for dfx command completion in your terminal, significantly improving your command-line productivity.
Automatic Setup Features
The dashboard provides intelligent shell completion setup with comprehensive automation:
Shell Detection
Automatically identifies your current shell environment
Support Status
Shows whether auto-setup is supported for your shell
One-Click Setup
Automatically configures completion for supported shells
Cross-Platform
Works on macOS, Linux, and Windows (WSL)
Supported Shell Environments
Manual Setup Options
For unsupported shells or manual configuration preference:
Copy Commands
Copy-to-clipboard commands for manual setup
Shell Instructions
Shell-specific instructions with proper syntax
Documentation Links
External documentation links for advanced configuration
Setup Process and Features
Shell Detection
The dashboard automatically detects your current shell environment
Compatibility Check
Verifies if auto-setup is supported for your shell
One-Click Setup
Use the toggle switch to enable/disable completion automatically
Manual Fallback
Copy manual setup commands for unsupported shells
After enabling shell completion, restart your terminal or run source ~/.{shell}rc to activate the completion. The completion provides auto-suggestions for dfx commands, subcommands, and options.
Profile File Management
When you update environment variables or set up shell completion through the DFX Dashboard, it intelligently manages your shell profile files:
Cross-Platform Profile Support
The Dashboard will attempt to update the first existing file it finds in the order listed above, or create the appropriate file if none exist. This ensures compatibility across different system configurations.
Best Practices
Troubleshooting
Advanced Configuration
Custom Cache Locations
Environment Variable Templates
Development Template
Pre-configured environment variables for development workflows
Production Template
Environment variables optimized for production deployments
Team Template
Shared environment configurations for team collaboration
Custom Template
Create custom environment variable templates
Additional Resources
DFX Configuration Reference
Complete reference for DFX configuration options
Environment Variables Guide
Comprehensive guide to DFX environment variables
Shell Completion Documentation
Official documentation for DFX shell completion
Version Management Guide
Guide to managing multiple DFX versions
Cache Management Documentation
Detailed cache management documentation
Troubleshooting Guide
Comprehensive troubleshooting for DFX issues
Ready to learn more about the DFX Dashboard? Continue to the About page for information about the application, version details, and additional resources.