Get content metadata of the repository
watermint toolbox stores credentials into the file system. That is located at below path:
Please do not share those files to anyone including Dropbox support. You can delete those files after use if you want to remove it. If you want to make sure removal of credentials, revoke application access from setting or the admin console.
Please see below help article for more detail:
|GitHub: Grants full access to repositories, including private repositories. That includes read/write access to code, commit statuses, repository and organization projects, invitations, collaborators, adding team memberships, deployment statuses, and repository webhooks for repositories and organizations. Also grants ability to manage user projects.|
For the first run,
tbx will ask you an authentication with your GitHub account. Please copy the link and paste it into your browser. Then proceed to authorization. After authorization, Dropbox will show you an authorization code. Please copy that code and paste it to the
watermint toolbox xx.x.xxx ========================== © 2016-2022 Takayuki Okazaki Licensed under open source licenses. Use the `license` command for more detail. 1. Visit the URL for the auth dialogue: https://github.com/login/oauth/authorize?client_id=xxxxxxxxxxxxxxxxxxxx&redirect_uri=http%3A%2F%2Flocalhost%3A7800%2Fconnect%2Fauth&response_type=code&scope=repo&state=xxxxxxxx 2. Click 'Allow' (you might have to login first): 3. Copy the authorisation code: Enter the authorisation code
Please download the pre-compiled binary from Latest Release. If you are using Windows, please download the zip file like
tbx-xx.x.xxx-win.zip. Then, extract the archive and place
tbx.exe on the Desktop folder.
The watermint toolbox can run from any path in the system if allowed by the system. But the instruction samples are using the Desktop folder. Please replace the path if you placed the binary other than the Desktop folder.
This document uses the Desktop folder for command example.
cd $HOME\Desktop .\tbx.exe services github content get
$HOME/Desktop/tbx services github content get
Note for macOS Catalina 10.15 or above: macOS verifies Developer identity. Currently,
tbx is not ready for it. Please select “Cancel” on the first dialogue. Then please proceed “System Preference”, then open “Security & Privacy”, select “General” tab.
You may find the message like:
“tbx” was blocked from use because it is not from an identified developer.
And you may find the button “Allow Anyway”. Please hit the button with your risk. At second run, please hit button “Open” on the dialogue.
||Owner of the repository|
||Path to the content|
||Name of reference|
||Name of the repository|
||Auto open URL or artifact folder||false|
||Bandwidth limit in K bytes per sec for upload/download content. 0 for unlimited||0|
||Memory budget (limits some feature to reduce memory footprint)||normal|
||Storage budget (limits logs or some feature to reduce storage usage)||normal|
||Maximum concurrency for running operation||Number of processors|
||Enable debug mode||false|
||Enable experimental feature(s).|
||Extra parameter file path|
||Output format (none/text/markdown/json)||text|
||HTTP/HTTPS proxy (hostname:port). Please specify
||Suppress non-error messages, and make output readable by a machine (JSON format)||false|
||Job data retain policy||default|
||Do not store tokens into a file||false|
||Show current operations for more detail.||false|
Report file path will be displayed last line of the command line output. If you missed command line output, please see path below. [job-id] will be the date/time of the run. Please see the latest job-id.
The command will generate a report in three different formats.
|type||Type of content|
If you run with
-budget-memory low option, the command will generate only JSON format report.
In case of a report become large, a report in
.xlsx format will be split into several chunks like follows;
The executable automatically detects your proxy configuration from the environment. However, if you got an error or you want to specify explicitly, please add -proxy option, like -proxy hostname:port. Currently, the executable doesn’t support proxies which require authentication.