This repository is no longer active. The floatingfile CLI has migrated into the monorepo.

The Official CLI for floatingfile

floatingfile is a file sharing platform that marries the flexibility of file storage applications with the convenience of file transfer applications.

Functions

At the moment, the CLI has not reached feature parity with the web and iOS applications, but this is the goal.

• Create a space
• Destroy a space
• Upload a file (or files)
• Remove a file (or files)
• Download a file (or files)
• View files
• View users
• View space's history (logs)
• Download files as zip
• Download and remove all files in a space

Roadmap

• Documentation and usage guides
• Persist code between executions
• Keep a record of visited, active spaces and allow users to swap between spaces
• Upload all files in a directory
• Sync a local directory with the contents of a space

Installation

Linux

TODO

Windows

TODO

Mac

The floatingfile CLI can be installed with the installation script or by executing the following commands. Be sure to double check the releases page to ensure the latest version is being downloaded.

1. Download and extract the latest binary

$ curl -L https://github.com/garethlau/floatingfile-cli/releases/download/v1.2.0/floatingfile-v1.2.0.tar.gz | tar -xz

2. Move the application to the appropriate folder

$ sudo mv floatingfile /opt/

3. Create symlink to access the floatingfile CLI globally. By default, Mac OS X has /usr/local/bin in the PATH.

sudo ln -s /opt/floatingfile/floatingfile /usr/local/bin

4. OPTIONAL but recommended: You can rename the executable for easier usage.

$ mv /usr/local/bin/floatingfile /usr/local/bin/ff

The floatingfile CLI is now accessible via the ff command. For example:

$ ff create -h
> NAME
>    ff create - Create a space. This will overwrite the code saved in memory.
>
> SYNOPSIS
>    ff create -
>
> DESCRIPTION
>    Create a space. This will overwrite the code saved in memory.

Usage

Create a new space

$ floatingfile create
>
> >>> floatingfile
>
> Your newly created space can be accessed here:
> https://app.floatingfile.space/s/6B1574
>
> The code has been saved and will be used for following commands. If you wish to override this code, you can do so via the --code flag.

Destroy an existing space

$ floatingfile destroy
>
> >>> floatingfile
>
> Done!

Download files

$ floatingfile download
>
> >>> floatingfile
>
> ? Which file would you like to download?
> (0) test3
> (1) test1
$ 0
> Done!

Upload files

$ floatingfile upload ./test_files
>
> >>> floatingfile
>
> ? Which files do you want to upload?
> (0) test1.txt
> (1) test2.txt
> (2) test3.txt
$ 0 2
> [==============================] 100%
> Done!

List files

$ floatingfile files
>
> >>> floatingfile
>
> test3 248da3d2-4585-4216-8c28-52fcb18f63c4
> test1 aae092f2-81e0-4f2d-bb0f-b6348f66e209
> Done!

Remove files

$ floatingfile remove
>
> >>> floatingfile
>
> ? Which files(s) would you like to remove?
> (0) test3.txt
> (1) test1.txt
$ 0
> Done!