Command Line Upload to Box Personal Account

Box CLI

The Box CLI is a convenient control line tool which allows both technical and non-technical users to leverage the Box API to perform routine or bulk actions. At that place is no need to write whatever lawmaking, as these actions are executed through a set of commands.

Among other features, Box CLI includes the following functionality:

• Majority actions - A csv file can be used to execute commands in bulk, and each row of the spreadsheet is treated as an individual API phone call.
• As-User header - Act on behalf of another user.
• Search API - Search for files and folders in your Box Enterprise business relationship.

Table of contents

• Getting Started
  • CLI Installation
  • CLI and Server Authentication with JWT
• Usage
• Control Topics
• Questions, Bugs, and Feature Requests?
• Versions
  • Supported Version
  • Version schedule
• Contributing to the Box CLI
• Copyright and License

Getting Started

The most convenient way to get starting time with Box CLI is to follow Box CLI with OAuth two.0 guide. You will exist guided how to configure Box application and install CLI on your machine.

CLI Installation

Installers are available for Windows and macOS. However, the raw source-lawmaking is bachelor if you would like to build the CLI in other environments.

Windows & macOS Installers

To install the latest CLI on your automobile, download the latest .exe for Windows or .pkg for macOS for the latest release.

Linux & Node install

Additionally, the CLI can be installed as a Node parcel on whatsoever platform, including Linux. For this to work, y'all will demand to have Node JS installed on your machine.

npm install --global @box/cli

CLI and Server Authentication with JWT

Alternatively, to get started with the Box CLI, download and install CLI, set up a Box application using Server Hallmark with JWT and download the JSON configuration file from the Configuration page of your app in the Box Developer Console. Then, gear up the CLI by pointing it to your configuration file:

$              box configure:environments:add PATH_TO_CONFIG_FILE              Successfully added CLI surround "default"            

If you manually generated your own private key to utilise with JWT authentication, y'all will need to point the CLI to the location of your private key file:

$              box configure:environments:add PATH_TO_CONFIG_FILE --private-key-path PATH_TO_PRIVATE_KEY --name ManualKey              Successfully added CLI environment "ManualKey"            

Usage

$              box --version              box-cli/0.0.0 darwin-x64 node-v10.x.0              $              box users:go --assistance              Become information about a Box user              USAGE                              $ box users:get [ID]              ARGUMENTS                              ID  [default: me] ID of the user to get; defaults to the current user              OPTIONS                              -h, --help                             Show CLI help                              -south, --save                             Salvage report to default reports folder on disk                              -t, --token=token                      Provide a token to perform this phone call                              -5, --verbose                          Prove verbose output, which can be helpful for debugging                              -y, --yep                              Automatically reply yes to all confirmation prompts                              --as-user=equally-user                      Provide an ID for a user                              --bulk-file-path=bulk-file-path        File path to bulk .csv or .json objects                              --csv                                  Output formatted CSV                              --fields=fields                        Comma separated list of fields to show                              --json                                 Output formatted JSON                              --no-color                             Plough off colors for logging                              --salve-to-file-path=save-to-file-path  Override default file path to relieve written report              $              box users:get              Type: user              ID: '77777'              Name: Instance User              Login: user@example.com              Created At: '2016-12-07T17:30:40-08:00'              Modified At: '2018-xi-15T17:33:06-08:00'              Language: en              Timezone: America/Los_Angeles              Space Corporeality: 10737418240              Space Used: 53569393              Max Upload Size: 5368709120              Status: active              Job Title: ''              Phone: ''              Address: ''              Avatar URL: 'https://app.box.com/api/avatar/big/77777'            

Command Topics

• box autocomplete - Brandish autocomplete installation instructions
• box collaboration-allowlist - List collaboration allowlist entries
• box collaborations - Manage collaborations
• box collections - List your collections
• box comments - Manage comments on files
• box configure - Configure the Box CLI
• box device-pins - List all the device pins for your enterprise
• box events - Get events
• box files - Manage files
• box folders - Manage folders
• box groups - Listing all groups
• box assistance - Display help for the Box CLI
• box legal-hold-policies - List legal concur policies
• box login - Sign in with OAuth and set a new environment
• box metadata-cascade-policies - List the metadata pour policies on a folder
• box metadata-query - Create a search using SQL-like syntax to return items that lucifer specific metadata
• box metadata-templates - Get all metadata templates in your Enterprise
• box oss - Print a list of open up-source licensed packages used in the Box CLI
• box recent-items - Listing data near files accessed in the past 90 days up to a 1000 items
• box request - Manually specify a Box API request
• box retention-policies - Listing all retention policies for your enterprise
• box search - Search for files and folders in your Enterprise
• box shared-links - Manage shared links
• box sign-requests - Listing sign requests
• box storage-policies - List storage policies
• box tasks - Manage tasks
• box terms-of-service - List terms of services for your enterprise
• box tokens - Become a token. Returns the service account token past default
• box trash - List all items in trash
• box users - List all Box users
• box watermarking - Use a watermark on an item
• box web-links - Manage web links
• box webhooks - List all webhooks

Questions, Bugs, and Characteristic Requests?

Browse the issues tickets! Or, if that doesn't work, file a new one and someone will get back to you. If you lot have general questions about the Box API, yous can post to the Box Developer Forum.

Versions

We apply a modified version of Semantic Versioning for all changes. Come across version strategy for details which is constructive from thirty July 2022.

Supported Version

But the current MAJOR version of SDK is supported. New features, functionality, problems fixes, and security updates will just be added to the electric current MAJOR version.

A current release is on the leading edge of our SDK development, and is intended for customers who are in agile development and want the latest and greatest features. Instead of stating a release appointment for a new characteristic, we set a fixed minor or patch release cadence of maximum 2-3 months (while nosotros may release more oftentimes). At the aforementioned time, there is no schedule for major or breaking release. Instead, we volition communicate one quarter in advance the upcoming breaking change to allow customers to plan for the upgrade. We e'er recommend that all users run the latest available small release for any major version is in employ. Nosotros highly recommend upgrading to the latest SDK major release at the earliest convenient time and before the EOL engagement.

Version schedule

Version	Supported Environments	Land	Showtime Release	EOL/Terminated
3	Node.js 12+	Supported	01 Feb 2022	TBD
ii		EOL	14 December 2018	01 Feb 2022
1		EOL	01 Nov 2017	fourteen December 2018

Contributing to the Box CLI

1. Clone this repo.
2. Run npm install.
3. Run npm test to ensure everything is working.
4. Make the changes y'all want in the src/ directory. Be sure to add corresponding tests in the examination/ directory!
5. Create a pull request with your changes — we'll review it and help you get it merged.

For more information, delight see the Contribution guidelines.

Copyright and License

Copyright 2018 Box, Inc. All rights reserved.

Licensed nether the Apache License, Version two.0 (the "License"); you may non use this file except in compliance with the License. Y'all may obtain a copy of the License at

http://world wide web.apache.org/licenses/LICENSE-2.0

Unless required by applicable police or agreed to in writing, software distributed under the License is distributed on an "Equally IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

This software includes third party libraries, which are distributed nether their own licenses' terms; run into LICENSE-THIRD-PARTY.txt for details.

lasterhadeare.blogspot.com

Source: https://github.com/box/boxcli

Share this post