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

ockam status should provide more user friendly information when a user is enrolled #6063

Open
nazmulidris opened this issue Sep 24, 2023 · 4 comments · May be fixed by #6314
Open

ockam status should provide more user friendly information when a user is enrolled #6063

nazmulidris opened this issue Sep 24, 2023 · 4 comments · May be fixed by #6314

Comments

@nazmulidris
Copy link
Contributor

nazmulidris commented Sep 24, 2023

Current behavior

Running ockam status when a user is enrolled currently displays a lot of debug type information. This information might be useful for developers working on Command, but it isn't directly relevant for users who use the CLI app.

The following screenshot shows what this currently looks like for a user who has previously enrolled successfully using ockam enroll.

Image

To install Ockam command from a prebuilt binary or from source, please take a look at this README.md.

Desired behavior

Instead of the low level information that's currently displayed, we can think about the following categories of higher level status information:

  • liveness (in real time), eg: is a node currently running or stopped.
  • data (persistent), eg: what is the user's enrollment email address.

Here's a list of useful status information for the user that should be displayed when ockam status is run for an enrolled user.

  • Version of ockam command
  • Enrollment status
  • Email address used for enrollment
  • Trust context
  • Identities: Display a check mark like ✅ when a credential exists for an identity.
  • List of nodes: Display a red 🔴 or green 🟢 circle beside each node to show liveness.

Note that this type of information would not be used in filing bug reports where log data is required. Log data would be useful in situations where bug reports need to be filed when ockam crashes.


We love helping new contributors! ❤️
If you have questions or need help as you explore, please join us on Discord. If you're looking for other issues to contribute to, please checkout our good first issues.

@MJoaaquin
Copy link
Contributor

Hi! I would like to work on that

@mrinalwadhwa
Copy link
Member

mrinalwadhwa commented Sep 29, 2023

@MJoaaquin that's awesome, all yours. Please let us know if your have any questions as you explore. You can also ask questions on the contributors discord https://discord.gg/RAbjRr3kds

@MJoaaquin
Copy link
Contributor

@mrinalwadhwa I was able to set up the environment locally and reproduce the case. I'm starting to work on this.

@MJoaaquin
Copy link
Contributor

@mrinalwadhwa I give you an example of the information I am currently showing. Do you agree with this?
image

@MJoaaquin MJoaaquin linked a pull request Oct 5, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants