Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CLI support to generate default config #1095

Closed
2 of 5 tasks
hu55a1n1 opened this issue Jun 16, 2021 · 2 comments
Closed
2 of 5 tasks

Add CLI support to generate default config #1095

hu55a1n1 opened this issue Jun 16, 2021 · 2 comments
Labels
I: CLI Internal: related to the relayer's CLI O: usability Objective: cause to improve the user experience (UX) and ease using the product
Milestone

Comments

@hu55a1n1
Copy link
Member

hu55a1n1 commented Jun 16, 2021

Crate

ibc-relayer-cli

Summary

Add a CLI command to generate and output a config file with defaults.

Problem Definition

There is currently no way to create a default config file for hermes, so it would be nice to be able to generate a default config file that gives users a template to start with. In the future, we might also want to provide more config templates particularly for the tutorials in the hermes documentation and we could also provide a way to edit the config (maybe git style) using the CLI.

Proposal

We add the config command so that the interface is extensible to support future improvements such as config validation, etc. The generate subcommand could be interactive (based on the options it receives) to fill in parts of the default config template.

$ hermes config generate [options]
# prints the config to stdout

Acceptance Criteria

The config generate command must print a working config to stdout.


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate milestone (priority) applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@adizere adizere added this to the 08.2021 milestone Jun 24, 2021
@adizere adizere added I: CLI Internal: related to the relayer's CLI O: usability Objective: cause to improve the user experience (UX) and ease using the product labels Aug 3, 2021
@adizere adizere modified the milestones: 08.2021, Backlog Aug 3, 2021
@adizere adizere modified the milestones: Backlog, v1.2 Sep 30, 2022
@adizere
Copy link
Member

adizere commented Sep 30, 2022

Partly superseded by #2187. Prioritizing to next milestone, could be useful project for @Farhad-Shabani soon.

@adizere adizere modified the milestones: v1.2, v1.3 Oct 31, 2022
@adizere adizere added this to Hermes Dec 13, 2022
@adizere adizere moved this to 📋 Backlog in Hermes Dec 13, 2022
@seanchen1991 seanchen1991 modified the milestones: v1.3, Backlog Dec 13, 2022
@romac
Copy link
Member

romac commented Jan 24, 2024

This has been available for a while with the config auto command.

@romac romac closed this as completed Jan 24, 2024
@github-project-automation github-project-automation bot moved this from 📋 Backlog to ✅ Done in Hermes Jan 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: CLI Internal: related to the relayer's CLI O: usability Objective: cause to improve the user experience (UX) and ease using the product
Projects
Status: ✅ Done
Development

No branches or pull requests

4 participants