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

hyprctl should be more helpful discovering usage #4300

Open
hholst80 opened this issue Dec 30, 2023 · 5 comments
Open

hyprctl should be more helpful discovering usage #4300

hholst80 opened this issue Dec 30, 2023 · 5 comments
Labels
enhancement New feature or request

Comments

@hholst80
Copy link

hholst80 commented Dec 30, 2023

Description

[I] root@neo ~
# man hyprctl 
No manual entry for hyprctl
[I] root@neo ~ [16]
# 
[I] root@neo ~ [16]
# hyprctl --help
usage: hyprctl [(opt)flags] [command] [(opt)args]

commands:
    activewindow
    activeworkspace
    binds
    clients
    cursorpos
    devices
    dispatch
    getoption
    globalshortcuts
    hyprpaper
    instances
    keyword
    kill
    layers
    layouts
    monitors
    notify
    plugin
    reload
    setcursor
    seterror
    setprop
    splash
    switchxkblayout
    version
    workspacerules
    workspaces

flags:
    -j -> output in JSON
    --batch -> execute a batch of commands, separated by ';'
    --instance (-i) -> use a specific instance. Can be either signature or index in hyprctl instances (0, 1, etc)

[I] root@neo ~ [1]
# 

So far not terrible. But individual commands should help the user to explore and figure out the usage.

image

@hholst80 hholst80 added the enhancement New feature or request label Dec 30, 2023
@vaxerski
Copy link
Member

I mean that's what the wiki is for no?

@hholst80
Copy link
Author

hholst80 commented Dec 30, 2023

I think the CLI tooling should be helpful enough not to require me to have a working internet connection to do anything useful. For most commands it is sufficient to just give the command and it will emit some output. But to send a notification, I have to know the magic handshake. If I fail to provide the right format, the tool should tell me what the right format is.

@vaxerski
Copy link
Member

fair enough I guess

@JPDucky
Copy link

JPDucky commented Jan 27, 2024

I agree heavily with this, trying to figure out more advanced usage of hyprctl is a nightmare as the current given documentation does not go into much detail.

@vaxerski
Copy link
Member

MRs welcome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants