ben-ryder / rcl

A simple command line wrapper for rclone focused on easy folder syncing.

Hi I'm Ben 👋

🤔 About me...

• 👨‍💻 I'm intrested in all things web dev, especially developing with Node.js and React at the moment.
• ❤️ I'm a lover of open source software, looking to start contributing back more.

🌱 I'm currently exploring...

• Local-first web applications in my Athena and Localful projects.
• Design systems in my component library and design system Jigsaw.

rcl's Issues

Add a `config` command to simplify opening & editing the config file.

Describe your feature
The rcl config command will open the config file for simplicity rather than rcl reading in and outputting the file. A default editor of nano will be set in configuration which can be edited in the ~/.rcl-config file.

Is your suggestion related to any problems?
It is more cumbersome to type vim ~/.rcl-config than the suggested alternative of rcl config.
It also opens the chance in the future to provide more of a config interface, such as setting the editor used with a command like rcl config set editor vim or rcl config set --editor=vim.

Additional context
n/a

Release the MVP version

Describe your feature
Release the MVP version

Is your suggestion related to any problems?
n/a

Additional context
n/a

Remove the `list` command in favour of `view` command.

Describe your feature
Currently rcl list basically reads in and then throws back the ~/.rcl-config file. My common use case for list is to verify/view a particular entry which is hard to do using list as it returns everything.

The rcl view command will be added as a replacement to allow you to view the config of all entries like list but will also accept an optional argument of ENTRY_ID to view the config of a specific entry.

Is your suggestion related to any problems?
It is hard to pick out specific entries using rcl list.

Additional context
n/a

Look at installing rcl in a directory that is on PATH or adding the directory automatically.

Describe your improvement
When installing via pip, pip gives a warning about the install location not being on $PATH. For example:

WARNING: The script rcl is installed in '/Users/<user>/Library/Python/2.7/bin' which is not on PATH.
Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.

This means rcl won't be found until you add the directory mentioned to $PATH.
It would be nice if this could be done automatically, or the program is installed somewhere else where this isn't an issue.
I don't know if this is possible or feasible, but it would be nice to make installation easier.

Is your suggestion related to any problems?
When installed though pip, rcl is installed to a directory that is often not on $PATH. (For example /Users/<user>/Library/Python/2.7/bin or /home/ubuntu/.local/bin depending on OS.)

Additional context
n/a

Import error for "rcl_helpers" when running after pip install.

Describe the bug
The application is crashing with:

Traceback (most recent call last):
  File "/Users/<user>/Library/Python/3.7/bin/rcl", line 6, in <module>
    from rcl import cli
  File "/Users/<user>/Library/Python/3.7/lib/python/site-packages/rcl.py", line 5, in <module>
    import rcl_helpers
ModuleNotFoundError: No module named 'rcl_helpers'

This is occurring on a fresh install using pip. It is possibly due to a packaging problem or where the script is being saved. Some investigation is needed. I will also check documentation on packaging Click projects & python projects in general.

To Reproduce
Steps to reproduce the behaviour:

1. Install using pip.
2. Try to run the rcl command. (ran from ~)

Expected behaviour
It works...

System Information (please complete the following information):

• OS: Mac - Catalina 10.15.6
• Python Version: 3.7.3

Additional context
n/a

Add a `setup` command to install rclone and then run the initial setup.

Describe your feature
Add an rcl setup command which will install rclone and run the inital config setup.

• I plan to have the setup use the script install. (curl https://rclone.org/install.sh | sudo bash)
• The "initial config setup" will simply be rcl calling rclone config. rclone will still have to be configured manually following the documentation.

Is your suggestion related to any problems?
rclone has to be installed and setup totally separate to rcl.

Additional context
n/a

rclone commands will fail if file paths have spaces

Describe the bug
rclone commands will fail if file paths have spaces. rcl can handle spaces fine when adding them (if you use speech marks as expected) but rcl doesn't supply the paths to rcl with speechmarks causing an error like:

Command check needs 2 arguments maximum: you provided 6 non flag arguments: ["/home/ben/Media/Music" "-" "Christmas" "gdrive:Media/Music" "-" "Christmas"]

To Reproduce
Steps to reproduce the behaviour:

1. Add a folder path with spaces in it.
2. Try to run any commands.
3. rclone will error with something like Command check needs 2 arguments maximum: you provided 6 non flag arguments....

Expected behaviour
rcl will work with file paths with spaces

System Information (please complete the following information):

• OS: Ubuntu 18.04
• Python Version: Python 3.6.9
• rclone v1.53.0
  (Although these are not applicable, its an error with rcl not handling strings correctly.)

Additional context
n/a

Add a version option to the base rcl command.

Describe your feature
Add rcl --version. This will be adding an option to the base rcl command.

Is your suggestion related to any problems?
n/a

Additional context
n/a

Add some error handling to commands.

Describe your improvement
Add some error handling to commands.
Primary error handling will be around if a valid ENTRY_ID is supplied to commands and if the paths supplied in the add command are valid.
I will not try to catch or prettify errors within rclone itself.

Is your suggestion related to any problems?
There is currently little to no error handling.

Additional context
n/a