-
Notifications
You must be signed in to change notification settings - Fork 7
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
Create Graph Data Explorer CLI Tool #51
Comments
Now that we have improved the graph format to be more intuitive and inspectable, we can wait for a full-on data explorer. I'm moving this towards a later step, and a more immediately useful feature would be a way to export the graph database to YAML, which will satisfy the need for seeing into the database as well as be useful for backups. |
This comment was marked as outdated.
This comment was marked as outdated.
Would be a good idea to create a mock up of what we would want the explorer to look like, and document the features we would want for it. |
Is it being a CLI tool a hard requirement? egui has really good graph widgets, that may be more clear and usable for a really large database: |
Yeah, I think we want to start with a terminal UI because one major use-case would be debugging the production database on a remote server over SSH. Having an Egui UI would be awesome, too, but terminal is the higher priority.
Definitely, here are my thoughts on it so far:
It might also be good to have a "raw" browser mode where it just lists every key on the left, and the value of the selected key on the right. Here's the really raw work-in-progress view of what is currently in the repo: So we don't really need like a connected graph view for the database. We want something almost more like a "wiki page browser", where I can just kind of walk through the structure of the graph. |
It's probably best just to continue with our own TUI, but I did just find this which could be good reference: https://github.com/UnkwUsr/nctok |
came here through the ratatui discord also:
|
Hi @AnarchistHoneybun! I updated the discord link, and here it is, also. Regarding the data we want displayed, you can see the The idea is that we want to be able to view the values in each document, which is a key-value store. The The The filesystem analogy only goes so far, though, because any key can have subkeys, so "files" can have "files" in them. What we want to do is allow you to browse the keys kind of like a filebrowser, where you have this concept of a "current working prefix" or breadcrumb, and it shows the keys under that prefix for one level deep. When you "hover" over a key, then it should show you the value in the right-hand panel, whether that be a string, or a number, or bytes ( which should be base32 encoded for display I think ). A value type that we'll want special handling for is a I may have already said some of that above, but hopefully that gets the idea across a little better. |
@AnarchistHoneybun seems you already had a good project with Ratatui https://github.com/AnarchistHoneybun/cl_2048 💯 |
tyvm! i love mocking up tui's, that was probably my first full scale project using one. the iteration speed is so fast with these I really love how soon projects start coming together |
Right now it's tricky to see what data is in our database, since we use a custom graph format, so we should have a CLI tool that can be used to explore, edit, and export our graph data.
This is kind of a necessity at this point for debugging purposes. We can do a simple CLI interface using ratatui.
The text was updated successfully, but these errors were encountered: