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

--help is incomplete #216

Open
svenstaro opened this issue Apr 1, 2024 · 1 comment
Open

--help is incomplete #216

svenstaro opened this issue Apr 1, 2024 · 1 comment

Comments

@svenstaro
Copy link

I noticed that --help is quite incomplete:

immich-go --help
immich-go  dev, commit none, built at unknown
Usage of main:
  -api string
        Immich api endpoint (http://container_ip:3301)
  -api-trace
        enable api call traces
  -debug
        enable debug messages
  -device-uuid string
        Set a device UUID
  -key string
        API Key
  -log-file string
        Write log messages into the file
  -log-level string
        Log level (Error|Warning|OK|Info), default OK
  -no-colors-log
        Disable colors on logs
  -server string
        Immich server address (http://<your-ip>:2283 or https://<your-domain>)
  -skip-verify-ssl
        Skip SSL verification
  -time-zone string
        Override the system time zone
  -use-configuration string
        Specifies the configuration to use (default "/home/user/.immich-go/immich-go.json")

The README lists a lot more options and sub-commands. I think it would be great to have a fully self-documenting tool that won't need users to look elsewhere for the full set of possible options.

@simulot
Copy link
Owner

simulot commented Apr 2, 2024

This is related to go package for getting the command line arguments.
I'm planning to switch to cobra https://github.com/spf13/cobra that's provide a better implementation of linux standards, and more possibilities for building the help page.
But this will introduce a breaking change

On the todo list

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

No branches or pull requests

2 participants