Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add flags for printing information about a specific cheatsheet #757

@carbon-steel

Description

@carbon-steel

Describe the solution you'd like
Add flags to the cheat cli that prints information (syntax, tags, path) about a given cheatsheet.

Describe alternatives you've considered
I've thought about writing my own scripts to parse the frontmatter from cheatsheets, but given that the front matter parsing logic is already in this cli (part of its internal implementation), I felt the feature would be better as part of the cli itself.

Additional context
Enabling cheatsheet introspection would help users integrate the cheat cli into their environments. For example, I have a keymap that writes the output of the cheat cli into a buffer in neovim. This allows me to edit commands right from that very buffer (which is a lot easier than editing commands from the commandline). However, there is no easy way for me to set the correct syntax highlighting for that specific cheatsheet as there is no direct way for me to access the syntax frontmatter field from that cheatsheet.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions