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

initialise config file #55

Closed
berendsliedrecht opened this issue Feb 16, 2022 · 4 comments
Closed

initialise config file #55

berendsliedrecht opened this issue Feb 16, 2022 · 4 comments
Assignees
Labels
Release V1 These issues should be resolved for a first open release

Comments

@berendsliedrecht
Copy link
Member

berendsliedrecht commented Feb 16, 2022

We need an easy for the user to initialise the configuration file.

Proposed:

aries-cli config --initialise

this could also be aliased to:

aries-cli init

The first one would be more extensible, e.g. editing, but the first one is more user-friendly. Aliasing is the preferred solution here IMO.

@berendsliedrecht berendsliedrecht added the Release V1 These issues should be resolved for a first open release label Feb 16, 2022
@berendsliedrecht berendsliedrecht self-assigned this Feb 16, 2022
@jl-animo
Copy link
Contributor

jl-animo commented Feb 25, 2022

Hm, I wonder whether we should do:

aries-cli config init

I think of --coolflag as modifiers to an action, not the action itself. Then, in future, we could have what you suggested:

  • aries-cli config edit --editor /usr/bin/vim
  • aries-cli -e my-env config set <key> <value>
  • not that we want to, just illustrating action vs. modifier aries-cli config init --filetype ini

however, I think it'd be totally fine to alias aries-cli config init to aries-cli init and advertise users to rather just do aries-cli init when getting started.

@jl-animo
Copy link
Contributor

jl-animo commented Feb 25, 2022

Tangential thought: We could even remove the requirement that they run aries-cli init and just read a "default" config if they have not created one. however, I see this could add some friction down the road when they want to add a new environment and then we tell them about aries-cli init 🤔

@berendsliedrecht
Copy link
Member Author

The default configuration has to be initialised to read from. We don't want to release the tool with a default linkt to our cloud agent because of load. So with a more proper release this init with our cloud agent will be removed.

@berendsliedrecht
Copy link
Member Author

@jl-animo right now this is the api.

image

I agree strongly with your point on flags modifying the action and subcommands being the action. How would you structure this? we need a view, to simply log the default config file, and an initialise.

I assume you would like Aries-cli configuration initialise and Aries-cli configuration view ? If so, is this something you would like tho pick up?

gitbook-com bot pushed a commit that referenced this issue Apr 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Release V1 These issues should be resolved for a first open release
Projects
None yet
Development

No branches or pull requests

2 participants