Config
octopipe config Command Reference
The octopipe config command manages both global and project-specific configurations. This command allows you to set, get, and list configuration values that control various aspects of Octopipe’s behavior.
Purpose
- Configuration Management: Adjust settings that govern pipeline behavior, authentication, and integration parameters.
- Customization: Tailor Octopipe to your environment by setting default values for sources, destinations, and other settings.
- Troubleshooting: Quickly view and modify configuration settings to resolve issues or optimize performance.
Usage
Subcommands
set
• Purpose: Set or update a configuration value.
• Usage Example:
• Arguments:
• <key>: The configuration key to set.
• <value>: The value to assign to the key.
get
• Purpose: Retrieve the current value of a configuration setting.
• Usage Example:
• Arguments:
• <key>: The configuration key to retrieve.
list
• Purpose: List all current configuration settings.
• Usage Example:
Detailed Behavior
• Setting Values:
When a value is set, Octopipe updates the configuration file or local storage accordingly. This may trigger changes in the behavior of subsequent commands.
• Retrieving Values:
The get command returns the value associated with a key, enabling quick verification of your configuration.
• Listing Configurations:
The list command outputs all active configuration settings, which is useful for auditing and troubleshooting.
Examples
Example 1: Set a Global LLM Model
Example 2: Retrieve a Specific Configuration Value
Example 3: List All Configurations
Best Practices
• Version Control:
Keep your configuration files under version control to track changes over time.
• Sensitive Data:
Avoid storing sensitive information directly; use environment variables or secret management tools.
• Documentation:
Maintain clear documentation on what each configuration key does and its accepted values.
Troubleshooting
• Unexpected Values:
If a configuration value is not working as expected, verify that it has been correctly set using the get command.
• Configuration Overrides:
Remember that project-specific configurations can override global settings. Use the list command to see all active configurations.
• Reloading Changes:
Some configuration changes may require a restart of the Octopipe service to take effect.
Conclusion
The octopipe config command provides a flexible way to manage your Octopipe environment. By mastering the use of set, get, and list operations, you can ensure that your system is configured correctly and remains easy to maintain.