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

docs: update the CLI usage documentation #322

Closed
rdimitrov opened this issue Jun 17, 2022 · 3 comments
Closed

docs: update the CLI usage documentation #322

rdimitrov opened this issue Jun 17, 2022 · 3 comments

Comments

@rdimitrov
Copy link
Contributor

The documentation about the usage of both repository and client side CLIs should be refreshed so it matches the current features which go-tuf provides.

The things that need to be fixed are the following (nevertheless it won't hurt if we have a look at the rest too):

  • tuf-client init does not work with root keys anymore, but instead uses the root.json file as per the spec (Thanks to Alex Khanin for raising that in #tuf (CNCF Slack channel)).
  • In the same context, tuf root-keys command is obsolete too.
  • tuf regenerate is not implemented yet, so maybe we can remove it if it's something we don't need or plan for the time being?

Note:
Removing the root-keys command might also be followed by removing the init implementation we kept as being backwards compatible. For reference - #210 and #208

@keerthi-nallaginela
Copy link

Hi, Can I take this up?

@rdimitrov
Copy link
Contributor Author

@keerthi-nallaginela - Of course! Let us know if there is anything we can help you with 👍

@rdimitrov
Copy link
Contributor Author

Closing since the code base changed and this is no longer valid.

Thanks for raising this 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants