intuis / rustmission

TUI for Transmission
GNU General Public License v3.0
34 stars 4 forks source link

Add CLI command to print default config and keymap to stdout #83

Closed micielski closed 3 months ago

micielski commented 3 months ago

In case there's a breaking change in the config, the user will have a reference of newest default config / keymap without having to go to github

CouldBeFree commented 3 months ago

if I understood you correctly, the user should see the following file content in the console?

# Whether to hide empty columns or not
auto_hide = false

# Possible values: Red, Green, Blue, Yellow, Magenta, Cyan.
# Use prefix "Light" for a brighter color.
# It can also be a hex, e.g. "#3cb371"
accent_color = "LightMagenta"

# If enabled, shows various keybindings throughout the program at the cost of
# a little bit cluttered interface.
beginner_mode = true

# If enabled, hides header row of torrents tab
headers_hide = false

[connection]
url = "http://CHANGE_ME:9091/transmission/rpc" # REQUIRED!

# Refresh timings (in seconds)
torrents_refresh = 5
stats_refresh = 5
free_space_refresh = 10

# If you need username and password to authenticate:
# username = "CHANGE_ME"
# password = "CHANGE_ME"

[torrents_tab]
# Available fields:
# Id, Name, SizeWhenDone, Progress, DownloadRate, UploadRate, DownloadDir,
# Padding, UploadRatio, UploadedEver, AddedDate, ActivityDate, PeersConnected
# SmallStatus
headers = ["Name", "SizeWhenDone", "Progress", "DownloadRate", "UploadRate"]
micielski commented 3 months ago

Yes! This, and also the keymap (seperate command). If you want to implement this, default configs are currently stored somewhere in rm-config as consts under the name of DEFAULT_CONFIG

CouldBeFree commented 3 months ago

I want to try implement this feature. What command name should display the file content?

micielski commented 3 months ago

Maybe print-defaultconfig and print-defaultkeymap?

CouldBeFree commented 3 months ago

I tried to run the project locally by running the cargo run command and I got this error

Error: error sending request for url (http://change_me:9091/transmission/rpc): error trying to connect: dns error: failed to lookup address information: nodename nor servname provided, or not known
Is the connection info in "/Users/Oleksandr.Zoria/.config/rustmission/config.toml" correct?

How can I configure project locally?

micielski commented 3 months ago

You would have to set up Transmission, but that's not really necessary to implement this feature. Commands that don't interact in any way with Transmission can be run without it, like rustmission --help.