search

simulot / immich-go

An alternative to the immich-CLI command that doesn't depend on nodejs installation. It tries its best for importing google photos takeout archives.
GNU Affero General Public License v3.0
1.2k stars 36 forks source link

`--help` is incomplete #216

Open svenstaro opened 3 months ago

svenstaro commented 3 months ago

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 commented 3 months ago

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