slimtoolkit/slim

CLI Enhancement: Ability to specify all command parameters in a json file ("command-params-file" flag)

Open

#597 opened on Oct 22, 2023

View on GitHub
 (5 comments) (1 reaction) (0 assignees)Go (17,694 stars) (673 forks)batch import
enhancementgood first issuehelp wanted

Description

Right now each CLI command accepts a set of command parameters as separate command line flags. It's ok for adhoc use, but it's less ideal for automation. The goal for the "command-params-file" flag is to provide an ability to specify all required command-specific parameters in one JSON formatted file.

There's already a placeholder for the flag, but there's no logic to load and process the file data.

This is a good first issue for somebody already comfortable with Go and refactoring a significant amount of CLI flag processing code.

Contributor guide

Tech stack
go
Domain
cli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Go language knowledgeCLI flag handling experience
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The issue describes a placeholder flag already exists in the CLI code. To implement, examine the CLI command definitions in the repository (likely using a library like cobra) to understand how flags are currently processed. The task is to add logic that reads a JSON file specified by the flag, parses its contents, and maps them to the appropriate command parameters. Look at existing examples of flag handling in the codebase for reference. Ensure that any conflicts or overrides between file parameters and direct flags are handled clearly.