search

tywil04 / slavartdl

Simple tool written in Go(lang) to download music using the SlavArt Divolt server
GNU General Public License v3.0
18 stars 1 forks source link

Don't understand the "completion" command #12

Closed Porygon31 closed 1 year ago

Porygon31 commented 1 year ago

Hi, I don't understand the completion command. I think you should add a description of it in the readme.

slavartdl version: 1.1.8

image

tywil04 commented 1 year ago

The completion command is part of Cobra, the library I am using for routing commands. When you run it, it will generate a script that will allow the command to autocomplete in your given shell (Linux uses bash by default, Windows uses powershell(?) by default and I think MacOS uses zsh by default.

I haven't chosen to explain it up until this point because I felt that the short message provided is enough. It can't hurt to document it further so I'll add some mention to the readme or I will find a way to remove it (I have never used it and never needed it for autocomplete to function).

Porygon31 commented 1 year ago

Okay, I understand now, I wasn't aware it was a default command. The name is quite misleading, haha. I thought it was an essential command, and since there was no mention of it in the readme, I preferred to ask the question.

I think you should specify that this command is there by default, and it's not useful for the application's usage.

Thanks 👍

tywil04 commented 1 year ago

The command will be hidden by default following release v1.1.10 onward.

heres the commit that hides it if your interested: https://github.com/tywil04/slavartdl/commit/efbf6d5ea43afa815f956480d6003b72d9c00e91