Report team namespace status summary.
watermint toolbox stores credentials into the file system. That is located at below path:
| OS | Path |
|---|---|
| Windows | %HOMEPATH%\.toolbox\secrets (e.g. C:\Users\bob.toolbox\secrets) |
| macOS | $HOME/.toolbox/secrets (e.g. /Users/bob/.toolbox/secrets) |
| Linux | $HOME/.toolbox/secrets (e.g. /home/bob/.toolbox/secrets) |
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:
| Description |
|---|
| Dropbox for teams: View your team membership |
| Dropbox for teams: View your Dropbox sharing settings and collaborators |
| Dropbox for teams: View structure of your team’s and members’ folders |
| Dropbox for teams: View and edit content of your team’s files and folders |
| Dropbox for teams: View basic information about your team including names, user count, and team settings |
For the first run, tbx will ask you an authentication with your Dropbox 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 tbx.
watermint toolbox xx.x.xxx
==========================
© 2016-2024 Takayuki Okazaki
Licensed under open source licenses. Use the `license` command for more detail.
1. Visit the URL for the auth dialogue:
https://www.dropbox.com/oauth2/authorize?client_id=xxxxxxxxxxxxxxx&response_type=code&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.
Windows:
cd $HOME\Desktop
.\tbx.exe dropbox team namespace summary
macOS, Linux:
$HOME/Desktop/tbx dropbox team namespace summary
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.
| Option | Description | Default |
|---|---|---|
-peer |
Account alias | default |
-skip-member-summary |
Skip scanning member namespaces | false |
| Option | Description | Default |
|---|---|---|
-auth-database |
Custom path to auth database (default: $HOME/.toolbox/secrets/secrets.db) | |
-auto-open |
Auto open URL or artifact folder | false |
-bandwidth-kb |
Bandwidth limit in K bytes per sec for upload/download content. 0 for unlimited | 0 |
-budget-memory |
Memory budget (limits some feature to reduce memory footprint) | normal |
-budget-storage |
Storage budget (limits logs or some feature to reduce storage usage) | normal |
-concurrency |
Maximum concurrency for running operation | Number of processors |
-debug |
Enable debug mode | false |
-experiment |
Enable experimental feature(s). | |
-extra |
Extra parameter file path | |
-lang |
Display language | auto |
-output |
Output format (none/text/markdown/json) | text |
-output-filter |
Output filter query (jq syntax). The output of the report is filtered using jq syntax. This option is only applied when the report is output as JSON. | |
-proxy |
HTTP/HTTPS proxy (hostname:port). Please specify DIRECT if you want skip setting proxy. |
|
-quiet |
Suppress non-error messages, and make output readable by a machine (JSON format) | false |
-retain-job-data |
Job data retain policy | default |
-secure |
Do not store tokens into a file | false |
-skip-logging |
Skip logging in the local storage | false |
-verbose |
Show current operations for more detail. | false |
-workspace |
Workspace path |
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.
| OS | Path pattern | Example |
|---|---|---|
| Windows | %HOMEPATH%\.toolbox\jobs\[job-id]\reports |
C:\Users\bob.toolbox\jobs\20190909-115959.597\reports |
| macOS | $HOME/.toolbox/jobs/[job-id]/reports |
/Users/bob/.toolbox/jobs/20190909-115959.597/reports |
| Linux | $HOME/.toolbox/jobs/[job-id]/reports |
/home/bob/.toolbox/jobs/20190909-115959.597/reports |
Folders without parent folder.
The command will generate a report in three different formats. folder_without_parent.csv, folder_without_parent.json, and folder_without_parent.xlsx.
| Column | Description |
|---|---|
| shared_folder_id | The ID of the shared folder. |
| parent_shared_folder_id | The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder. |
| name | The name of the this shared folder. |
| access_type | The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment) |
| path_lower | The lower-cased full path of this shared folder. |
| is_inside_team_folder | Whether this folder is inside of a team folder. |
| is_team_folder | Whether this folder is a team folder. |
| policy_manage_access | Who can add and remove members from this shared folder. |
| policy_shared_link | Who links can be shared with. |
| policy_member_folder | Who can be a member of this shared folder, as set on the folder itself. |
| policy_member | Who can be a member of this shared folder, as set on the folder itself (team, or anyone) |
| policy_viewer_info | Who can enable/disable viewer info for this shared folder. |
| owner_team_id | Team ID of the folder owner team |
| owner_team_name | Team name of the team that owns the folder |
| access_inheritance | Access inheritance type |
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; folder_without_parent_0000.xlsx, folder_without_parent_0001.xlsx, folder_without_parent_0002.xlsx, …
Member namespace summary
The command will generate a report in three different formats. member.csv, member.json, and member.xlsx.
| Column | Description |
|---|---|
| Member email address | |
| total_namespaces | Number of total namespaces (excluding member root namespace) |
| mounted_namespaces | Number of mounted folders |
| owner_namespaces | Number of shared folders owned by this member |
| team_folders | Number of team folders |
| inside_team_folders | Number of folders inside team folders |
| external_folders | Number of folders shared by a user outside the team |
| app_folders | Number of app folders |
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; member_0000.xlsx, member_0001.xlsx, member_0002.xlsx, …
Team namespace summary.
The command will generate a report in three different formats. team.csv, team.json, and team.xlsx.
| Column | Description |
|---|---|
| namespace_type | Type of namespace |
| namespace_count | Number of namespaces |
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; team_0000.xlsx, team_0001.xlsx, team_0002.xlsx, …
Team folder summary.
The command will generate a report in three different formats. team_folder.csv, team_folder.json, and team_folder.xlsx.
| Column | Description |
|---|---|
| name | Team folder name |
| num_namespaces_inside | Number of namespaces inside this team folder |
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; team_folder_0000.xlsx, team_folder_0001.xlsx, team_folder_0002.xlsx, …
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.