STORJ(1)

πŸ¦‹ STORJ β€” NAME πŸ¦‹

okay so bestie, meet STORJ(1) β€” the Command Line Tool for encrypted file transfer on the Storj network. that's the whole vibe. it's a CLI. it moves your encrypted files around. iconic behavior fr fr.


✨ SYNOPSIS ✨

storj [<options>] <command> [<args>]

like… that's it. that's the shape of it. <options> first (optional, but they're cute), then a <command>, then whatever <args> that command is hungry for πŸ’…


🌸 DESCRIPTION 🌸

so what is this thing? it's a CLI Tool for file transfer on the Storj network, and it gives you an interface for:

  • setting up users profiles πŸ‘‘
  • working with buckets and files πŸͺ£
  • downloading and uploading files πŸ’Ύ
  • getting information from the Storj API 🌐

that's the whole package. no cap. 🫢


πŸ’– OPTIONS πŸ’–

  • -h, --help β€” show help message and exit. the "wait what do i do" button πŸ₯Ί
  • -V, --version β€” show program's version number. flex the digits ✨
  • -u --url URL β€” set the base url for the api 🌐
  • -p --proxy URL β€” set the socks proxy, e.g. <[protocol://][user:password@]proxyhost[:port]> 🧦
  • -l --log LEVEL β€” set the log level (default 0) πŸ“‹
  • -d --debug β€” set the debug log level πŸ›

πŸŽ€ COMMANDS πŸŽ€

here's the whole menu bestie, every single one:

  • register β€” setup a new storj bridge user. new account, who dis πŸ’…
  • import-keys β€” import existing user. bringing your old self along 🫢
  • export-keys β€” export bridge user, password and encryption keys. back them up before something tragic happens 😭
  • list-buckets β€” lists all buckets from the current user. bucket reveal 🌈
  • list-files <bucket-id> β€” lists all files from the specified bucket. what's in the bucket, bestie πŸ‘€
  • remove-file <bucket-id> <file-id> β€” removes specified file from specified bucket. bye bye file πŸ¦‹
  • remove-bucket <bucket-id> β€” removes specified bucket. bye bye bucket πŸͺ£πŸ’€
  • list-mirrors <bucket-id> <file-id> β€” lists all mirrors where the specified bucket and file is stored. mirror mirror on the wall ✨
  • upload-file <bucket-id> <file-path> β€” uploads specified file to the specified bucket in the network. send it πŸš€
  • download-file <bucket-id> <file-id> <path> β€” downloads specified file and stores localy in the specified path. it's giving localy and we're keeping that spelling, periodt πŸ’–

🧚 ENVIRONMENT 🧚

these lil variables do the work behind the scenes, no cap:

  • STORJ_KEYPASS β€” imported user settings passphrase πŸ”‘
  • STORJ_BRIDGE β€” the bridge host πŸŒ‰
  • STORJ_BRIDGE_USER β€” bridge username πŸ‘€
  • STORJ_BRIDGE_PASS β€” bridge password πŸ”’
  • STORJ_BRIDGE_PASS β€” bridge password πŸ”’ (yes bestie, it's listed twice in the original. we don't edit the source of truth, we respect it πŸ’…)
  • STORJ_ENCRYPTION_KEY β€” file encryption key πŸ—οΈ

πŸ‘‘ AUTHOR πŸ‘‘

StorJ Labs, Inc. (2017)

This manual page was written by Josue Ortega <josue@debian.org>, for the Debian project (and may be used by others). 🫢


πŸ’€ BUGS πŸ’€

Report bugs to https://github.com/Storj/libstorj/issues

bestie if something's broken, don't suffer in silence β€” go tell the issue tracker. they wanna know. it's giving community πŸ’œ

okay that's the whole page, you ate it, you read every line, so proud πŸ₯Ή this was Version 1.0.2, dated August 30, 2017 β€” the STORJ(1) page, serving looks since 2017 βœ¨πŸ’…πŸŽ€