Skip to content

feat: add the ability to generate a config file#13

Merged
AKrantzPS merged 1 commit into
mainfrom
feat/create_config
Jun 29, 2026
Merged

feat: add the ability to generate a config file#13
AKrantzPS merged 1 commit into
mainfrom
feat/create_config

Conversation

@AKrantzPS

Copy link
Copy Markdown
Collaborator

This pull request introduces a new create-config CLI subcommand for generating starter configuration files, updates documentation to reflect this feature, and improves config file usage and examples throughout the project. The main changes are grouped into three themes: CLI feature addition, documentation updates, and config/example improvements.

New CLI Feature: Config Generation

  • Added a create-config subcommand to the CLI, allowing users to generate a starter config file (odsbox-diff.config.toml) with customizable options such as authentication type, inclusion of queries, and comment verbosity. This is implemented via the new create_config_file function and supporting logic in src/odsbox_diff/diff.py. [1] [2] [3] [4] [5]

Documentation Updates

  • Updated README.md and docs/usage.md to document the new create-config command, its flags, and usage examples. The documentation now recommends using the subcommand for generating starter configs and describes the resulting file structure. [1] [2] [3] [4] [5] [6]

Config and Example Improvements

  • Updated config example files to clarify usage, align with the new config structure, and switch keyring instructions to the simpler keyring set CLI. Also updated sample commands to match the new file naming and server section conventions. [1] [2] [3] [4] [5]

These changes make it much easier for users to get started with the tool and maintain consistent, secure configuration files.

@AKrantzPS AKrantzPS merged commit acc5428 into main Jun 29, 2026
4 checks passed
@AKrantzPS AKrantzPS deleted the feat/create_config branch June 29, 2026 11:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant