amruthpillai/fireup-cli

• Demo
• Description
• Installation
• Usage
• Commands

Demo

Description

I've always found myself on the terminal 90% of the time when I'm on my computer. The first thing I do when I wake up is fire up the command line, git pull all my projects and then I drink my coffee.

Given this lifestyle, I've also found it a pain to find a place to upload a certain file when I need to share them with friends privately, or upload an image publicly that I want to post on a forum/message board. Thus, fireup-cli was born. It taps into your Firebase Project's Storage Bucket to upload/download files to it, share links and delete them, all from your command line.

The motivation to go with Firebase Storage was simply that it was free and seemed like the most convenient. On the free Spark plan, you get 5 GB of storage with 1 GB of download bandwidth per day. If these limits are too restrictive for you, you can learn more about the Blaze plan here and upgrade your account.

Now, with fireup-cli, you can upload images, videos or just about anything right from your terminal with one simple command.

Installation

To install and set up fireup-cli for quick and easy uploads, all you need is:

1. Node.js installed on your machine, and node/npm in your PATH
2. Firebase Project you can upload to, you can create one for free here
3. Service Account JSON & Storage Bucket URL from above Firebase Project

Then, just run these commands:

$ npm install --global fireup-cli

$ fireup config:set service.account /path/to/service-account.json
$ fireup config:set storage.bucket <project-id>.appspot.com

Usage

$ fireup upload --file /path/to/file --public --clipboard

OR

$ fireup up /path/to/file -pc

Commands

• fireup upload [FILE]
• fireup history
• fireup config:set KEY VALUE
• fireup config:view
• fireup help [COMMAND]
• fireup update [CHANNEL]

fireup upload [FILE]

upload file to storage bucket

USAGE
  $ fireup upload [FILE]

ARGUMENTS
  FILE  path of the file you want to upload

OPTIONS
  -b, --bucket=bucket  link to firebase storage bucket,
  -c, --clipboard      copy generated link to clipboard
  -e, --expiry=expiry  [default: 4] hours until expiry of private link
  -f, --file=file      path of the file you want to upload
  -h, --help           show CLI help
  -l, --link           if private, generate a temporarily downloadable link
  -p, --public         make the file publicly-accessible

ALIASES
  $ fireup up

EXAMPLES
  $ fireup upload /path/to/file
  $ fireup upload -f /path/to/file --public
  $ fireup upload -f /path/to/file -pc
  $ fireup upload /path/to/file -le 10

See code: src/commands/upload.ts

fireup history

file upload history

USAGE
  $ fireup history

OPTIONS
  -d, --delete=delete  name of file to be deleted
  -h, --help           show CLI help
  -p, --public=public  make file public, get download URL
  -s, --signed=signed  make file private, get temporarily signed URL
  -v, --view           view upload history

ALIASES
  $ fireup hi

See code: src/commands/history.ts

fireup config:set KEY VALUE

set global config vars

USAGE
  $ fireup config:set KEY VALUE

ARGUMENTS
  KEY    (service.account|storage.bucket) config variable to modify
  VALUE  value to be set

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ fireup cs

EXAMPLES
  $ fireup cs service.account /path/to/file.json
  $ fireup config:set storage.bucket <project-id>.appspot.com

See code: src/commands/config/set.ts

fireup config:view

view global config vars

USAGE
  $ fireup config:view

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ fireup cv

See code: src/commands/config/view.ts

fireup help [COMMAND]

display help for fireup

USAGE
  $ fireup help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

fireup update [CHANNEL]

update the fireup CLI

USAGE
  $ fireup update [CHANNEL]

See code: @oclif/plugin-update