Categorygithub.com/twystd/unboxd
repository
0.0.0-20240123173639-83f9c0580e78
Repository: https://github.com/twystd/unboxd.git
Documentation: pkg.go.dev
Overview
Dependencies
0
Dependents
0

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# README

build

unboxd

A somewhat eclectic Go CLI for managing files and templates in Box:

  • list-folders
  • list-files
  • upload-file
  • delete-file
  • tag-file
  • untag-file
  • list-templates
  • create-template
  • get-template
  • delete-template

Currently supports authentication and authorisation using either Box client or JWT credentials.

Raison d'être

Mostly because another project needed a Go interface to the Box Content API and it turned out to be convenient to create it as a separate library and then the CLI turned out to be occasionally useful. So it by no means even vaguely approximates the official Box API implementations - it just implements some functionality in a way that was useful for a particular requirement.

Releases

EARLY DEVELOPMENT

VersionDescription

Installation

Building from source

Assuming you have Go v1.20+ and make installed:

git clone https://github.com/twystd/unboxd.git
cd unboxd
make build

If you prefer not to use make:

git clone https://github.com/twystd/unboxd.git
cd unboxd
go build -o bin/ ./...

Dependencies

ModuleVersion
youmark:PKCS8(latest)
cristalhq:JWTv4

unboxd

Usage: unboxd [options] <command> <arguments>

General_ commands:

  • help
  • version

Folder commands:

File commands:

Template commands:

General

help

Displays the usage information and a list of available commands. Command specific help displays the detailed usage for that command.

unboxd help

  Examples:

  unboxd help
  uhboxd help list-folders

version

Displays the current application version.

unboxd version

  Example:

  unboxd version

Folder commands

The folder commands wrap the Box Folder API:

unboxd list-folders

list-folders

Retrieves a list of folders matching the (optionally) supplied path

unboxd [options] list-folders [path]

  Options:
  --credentials <file> Sets the file containing the Box API credentials
  --debug              Displays verbose debugging information

  Example:

  unboxd --debug --credentials .credentials  list-folders /

  123456789 /unboxd
  987654321 /unboxd/photos
  876543219 /unboxd/docs
  765432198 /unboxd/docs/public
  …

File commands

The file commands wrap the Box File API:

unboxd list-files
unboxd upload-file
unboxd delete-file
unboxd tag-file
unboxd untag-file
unboxd retag-file

Template commands

The file commands wrap the Box Template API:

unboxd list-templates
unboxd get-template
unboxd create-template
unboxd delete-template

Notes

  1. https://github.com/golang/go/issues/8860

References