Categorygithub.com/watermint/toolbox
repositorypackage
0.0.0-20250818112437-43b016f70f53
Repository: https://github.com/watermint/toolbox.git
Documentation: pkg.go.dev

# 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
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

watermint toolbox

Build Test CodeQL Codecov

watermint toolbox

The watermint toolbox is the multi-purpose utility command-line tool for web services including Dropbox, Figma, GitHub, etc. The purpose of the tool is to provide users of cloud services and system administrators with a way to automate workflows and provide a work-around for some issues.

⚠️ Maintenance Status

⚠️ Important Notice: This project is no longer actively maintained.

As of August 2025, this project has entered Keep The Lights On (KTLO) mode. While the current version will continue to function, no new features, bug fixes, or API updates will be implemented. Only minimal security updates may be applied as needed.

For more details about this decision and recommendations for alternatives, please see: Project Maintenance Status - Discussion #911

Licensing & Disclaimers

watermint toolbox is licensed under the Apache License, Version 2.0. Please see LICENSE.md or LICENSE.txt for more detail.

Please carefully note:

Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.

Built executable

Pre-compiled binaries can be found in Latest Release. If you are building directly from the source, please refer BUILD.md.

Installing using Homebrew on macOS/Linux

First, you need to install Homebrew. Please refer the instruction on the official site. Then run following commands to install watermint toolbox.

brew tap watermint/toolbox
brew install toolbox

Product lifecycle

Maintenance policy

This product itself is experimental and is not subject to the maintained to keep quality of service. The project will attempt to fix critical bugs and security issues with the best effort. But that is also not guaranteed.\n\nThe product will not release any patch release of a certain major releases. The product will apply fixes as next release when those fixes accepted to do.

Specification changes

The deliverables of this project are stand-alone executable programs. The specification changes will not be applied unless you explicitly upgrade your version of the program.\n\nThe following policy will be used to make changes in new version releases.\n\nCommand paths, arguments, return values, etc. will be upgraded to be as compatible as possible, but may be discontinued or changed. The general policy is as follows.\n\n* Changes that do not break existing behavior, such as the addition of arguments or changes to messages, will be implemented without notice.\n* Commands that are considered infrequently used will be discontinued or moved without notice.\n* Changes to other commands will be announced 30-180 days or more in advance.\n\nChanges in specifications will be announced at Announcements. Please refer to Specification Change for a list of planned specification changes.\n

Availability period for each release

In general, new security issues are discovered every day. To avoid leaving these security and critical issues unaddressed by continuing to use older watermint toolbox releases, a maximum availability period has been set for release 130 and above. Please see #815 for more details.

Announcements

Security and privacy

The watermint toolbox is designed to simplify the use of cloud service APIs. It will not use the data in any way that is contrary to your intentions.

The watermint toolbox does not store the data it retrieves via the linked cloud service API on a separate server, contrary to the intent of the specified command.

For example, if you use the watermint toolbox to retrieve data from a cloud service, those data will only be stored on your PC. Furthermore, in the case of commands that upload files or data to a cloud service, they will only be stored in the location specified by your account.

Data protection

When you use the watermint toolbox to retrieve data from the cloud service API, your data is stored on your PC as report data or log data. More sensitive information, such as the authentication token for the cloud service API, is also stored on your PC.

It is your responsibility to keep these data stored on your PC secure.

Important information such as authentication tokens are obfuscated so that their contents cannot be easily read. However, this obfuscation is not intended to enhance security, but to prevent unintentional operational errors. If a malicious third party copies your token information to another PC, they may be able to access cloud services that you did not intend.

Use

As previously stated, the watermint toolbox is designed to store data on your PC or in your cloud account. Processes other than your intended operation include data retrieval for release lifecycle management, as outlined below.

The watermint toolbox has the capability to deactivate specific releases that have critical bugs or security issues. This is achieved by retrieving data from a repository hosted on GitHub approximately every 30 days to assess the status of a release. This access does not collect any private data (such as your cloud account information, local files, token, etc.). It merely checks the release status, but as a side effect, your IP address is sent to GitHub when downloading data.

Please be aware that this access information (date, time and IP address) may be used in the future to estimate the usage of each release.

Sharing

The watermint toolbox project does not currently manage or obtain data including IP addresses, information that only GitHub, the company that hosts the project, has the possibility to access. However, the project may in the future make this information available, and may disclose anonymised release-by-release usage to project members if deemed necessary for the operation of the project.

Any such changes will be announced on the announcement page and this security & privacy policy page at least 30 days before the change takes effect.

Usage

tbx has various features. Run without an option for a list of supported commands and options.\nYou can see available commands and options by running the executable without arguments as shown below.

% ./tbx

watermint toolbox xx.x.xxx
==========================

© 2016-2025 Takayuki Okazaki
Licensed under open source licenses. Use the `license` command for more detail.

This project is no longer actively maintained. For more details, see: https://github.com/watermint/toolbox/discussions/911

Tools for Dropbox and Dropbox for Teams

Usage:
======

./tbx  command

Available commands:
===================

| Command | Description              | Notes |
|---------|--------------------------|-------|
| asana   | Asana commands           |       |
| config  | CLI configuration        |       |
| deepl   | DeepL commands           |       |
| dropbox | Dropbox commands         |       |
| figma   | Figma commands           |       |
| github  | GitHub commands          |       |
| license | Show license information |       |
| local   | Commands for local PC    |       |
| log     | Log utilities            |       |
| slack   | Slack commands           |       |
| util    | Utilities                |       |
| version | Show version             |       |

Commands

DeepL

CommandDescription
deepl translate textTranslate text

Dropbox (Individual account)

CommandDescription
dropbox file account featureList Dropbox account features
dropbox file account filesystemShow Dropbox file system version
dropbox file account infoDropbox account info
dropbox file compare accountCompare files of two accounts
dropbox file compare localCompare local folders and Dropbox folders
dropbox file copyCopy files
dropbox file deleteDelete file or folder
dropbox file export docExport document
dropbox file export urlExport a document from the URL
dropbox file import batch urlBatch import files from URL
dropbox file import urlImport file from the URL
dropbox file infoResolve metadata of the path
dropbox file listList files and folders
dropbox file lock acquireLock a file
dropbox file lock all releaseRelease all locks under the specified path
dropbox file lock batch acquireLock multiple files
dropbox file lock batch releaseRelease multiple locks
dropbox file lock listList locks under the specified path
dropbox file lock releaseRelease a lock
dropbox file mergeMerge paths
dropbox file moveMove files
dropbox file replicationReplicate file content to the other account
dropbox file request createCreate a file request
dropbox file request delete closedDelete all closed file requests on this account.
dropbox file request delete urlDelete a file request by the file request URL
dropbox file request listList file requests of the individual account
dropbox file restore allRestore files under given path
dropbox file restore extRestore files with a specific extension
dropbox file revision downloadDownload the file revision
dropbox file revision listList file revisions
dropbox file revision restoreRestore the file revision
dropbox file search contentSearch file content
dropbox file search nameSearch file name
dropbox file share infoRetrieve sharing information of the file
dropbox file sharedfolder infoGet shared folder info
dropbox file sharedfolder leaveLeave the shared folder
dropbox file sharedfolder listList shared folders
dropbox file sharedfolder member addAdd a member to the shared folder
dropbox file sharedfolder member deleteRemove a member from the shared folder
dropbox file sharedfolder member listList shared folder members
dropbox file sharedfolder mount addAdd the shared folder to the current user's Dropbox
dropbox file sharedfolder mount deleteUnmount the shared folder
dropbox file sharedfolder mount listList all shared folders the current user has mounted
dropbox file sharedfolder mount mountableList all shared folders the current user can mount
dropbox file sharedfolder shareShare a folder
dropbox file sharedfolder unshareUnshare a folder
dropbox file sharedlink createCreate shared link
dropbox file sharedlink deleteRemove shared links
dropbox file sharedlink file listList files for the shared link
dropbox file sharedlink infoGet information about the shared link
dropbox file sharedlink listList shared links
dropbox file sizeStorage usage
dropbox file sync downDownstream sync with Dropbox
dropbox file sync onlineSync online files
dropbox file sync upUpstream sync with Dropbox
dropbox file tag addAdd tag to file or folder
dropbox file tag deleteDelete a tag from the file/folder
dropbox file tag listList tags of the path
dropbox file template applyApply file/folder structure template to the Dropbox path
dropbox file template captureCapture file/folder structure as template from Dropbox path
dropbox file watchWatch file activities
dropbox paper appendAppend the content to the end of the existing Paper doc
dropbox paper createCreate new Paper in the path
dropbox paper overwriteOverwrite an existing Paper document
dropbox paper prependAppend the content to the beginning of the existing Paper doc
util tidy pack remotePackage remote folder into the zip file

Dropbox Sign

CommandDescription
dropbox sign request listList signature requests
dropbox sign request signature listList signatures of requests

Dropbox for teams

CommandDescription
dropbox team activity batch userScan and retrieve activity logs for multiple team members in batch, useful for compliance auditing and user behavior analysis
dropbox team activity daily eventGenerate daily activity reports showing team events grouped by date, helpful for tracking team usage patterns and security monitoring
dropbox team activity eventRetrieve detailed team activity event logs with filtering options, essential for security auditing and compliance monitoring
dropbox team activity userRetrieve activity logs for specific team members, showing their file operations, logins, and sharing activities
dropbox team admin group role addAssign admin roles to all members of a specified group, streamlining role management for large teams
dropbox team admin group role deleteRemove admin roles from all team members except those in a specified exception group, useful for role cleanup and access control
dropbox team admin listDisplay all team members with their assigned admin roles, helpful for auditing administrative access and permissions
dropbox team admin role addGrant a specific admin role to an individual team member, enabling granular permission management
dropbox team admin role clearRevoke all administrative privileges from a team member, useful for role transitions or security purposes
dropbox team admin role deleteRemove a specific admin role from a team member while preserving other roles, allowing precise permission adjustments
dropbox team admin role listDisplay all available admin roles in the team with their descriptions and permissions
dropbox team backup device statusTrack Dropbox Backup status changes for all team devices over a specified period, monitoring backup health and compliance
dropbox team content legacypaper countCalculate the total number of legacy Paper documents owned by each team member, useful for content auditing and migration planning
dropbox team content legacypaper exportExport all legacy Paper documents from team members to local storage in HTML or Markdown format for backup or migration
dropbox team content legacypaper listGenerate a comprehensive list of all legacy Paper documents across the team with ownership and metadata information
dropbox team content member listDisplay all members with access to team folders and shared folders, showing permission levels and folder relationships
dropbox team content member sizeCalculate member counts for each team folder and shared folder, helping identify heavily accessed content and optimize permissions
dropbox team content mount listDisplay mount status of all shared folders for team members, identifying which folders are actively synced to member devices
dropbox team content policy listReview all access policies and restrictions applied to team folders and shared folders for governance compliance
dropbox team device listDisplay all devices and active sessions connected to team member accounts with device details and last activity timestamps
dropbox team device unlinkRemotely disconnect devices from team member accounts, essential for securing lost/stolen devices or revoking access
dropbox team featureDisplay all features and capabilities enabled for your Dropbox team account, including API limits and special features
dropbox team filerequest listDisplay all active and closed file requests created by team members, helping track external file collection activities
dropbox team filesystemIdentify whether your team uses legacy or modern file system architecture, important for feature compatibility
dropbox team group addCreate a new group in your team for organizing members and managing permissions collectively
dropbox team group batch addCreate multiple groups at once using batch processing, efficient for large-scale team organization
dropbox team group batch deleteRemove multiple groups from your team in batch, streamlining group cleanup and reorganization
dropbox team group clear externalidRemove external ID mappings from groups, useful when disconnecting from external identity providers
dropbox team group deleteRemove a specific group from your team, automatically removing all member associations
dropbox team group folder listDisplay all folders accessible by each group, showing group-based content organization and permissions
dropbox team group listDisplay all groups in your team with member counts and group management types
dropbox team group member addAdd individual team members to a specific group for centralized permission management
dropbox team group member batch addAdd multiple members to groups efficiently using batch processing, ideal for large team reorganizations
dropbox team group member batch deleteRemove multiple members from groups in batch, streamlining group membership management
dropbox team group member batch updateUpdate group memberships in bulk by adding or removing members, optimizing group composition changes
dropbox team group member deleteRemove a specific member from a group while preserving their other group memberships
dropbox team group member listDisplay all members belonging to each group, useful for auditing group compositions and access rights
dropbox team group renameChange the name of an existing group to better reflect its purpose or organizational changes
dropbox team group update typeChange how a group is managed (user-managed vs company-managed), affecting who can modify group membership
dropbox team infoDisplay essential team account information including team ID and basic team settings
dropbox team insight scanPerform comprehensive data scanning across your team for analytics and insights generation
dropbox team legalhold addCreate a legal hold policy to preserve specified team content for compliance or litigation purposes
dropbox team legalhold listDisplay all active legal hold policies with their details, members, and preservation status
dropbox team legalhold member batch updateAdd or remove multiple team members from legal hold policies in batch for efficient compliance management
dropbox team legalhold member listDisplay all team members currently under legal hold policies with their preservation status
dropbox team legalhold releaseRelease a legal hold policy and restore normal file operations for affected members and content
dropbox team legalhold revision listDisplay all file revisions preserved under legal hold policies, ensuring comprehensive data retention
dropbox team legalhold update descModify the description of an existing legal hold policy to reflect changes in scope or purpose
dropbox team legalhold update nameChange the name of a legal hold policy for better identification and organization
dropbox team linkedapp listDisplay all third-party applications linked to team member accounts for security auditing and access control
dropbox team member batch deleteRemove multiple team members in batch, efficiently managing team departures and access revocation
dropbox team member batch detachConvert multiple team accounts to individual Basic accounts, preserving personal data while removing team access
dropbox team member batch inviteSend batch invitations to new team members, streamlining the onboarding process for multiple users
dropbox team member batch reinviteResend invitations to pending members who haven't joined yet, ensuring all intended members receive access
dropbox team member batch suspendTemporarily suspend multiple team members' access while preserving their data and settings
dropbox team member batch unsuspendRestore access for multiple suspended team members, reactivating their accounts in batch
dropbox team member clear externalidRemove external ID mappings from team members, useful when disconnecting from identity management systems
dropbox team member featureDisplay feature settings and capabilities enabled for specific team members, helping understand member permissions
dropbox team member file lock all releaseRelease all file locks held by a team member under a specified path, resolving editing conflicts
dropbox team member file lock listDisplay all files locked by a specific team member under a given path, identifying potential collaboration blocks
dropbox team member file lock releaseRelease a specific file lock held by a team member, enabling others to edit the file
dropbox team member file permdeletePermanently delete files or folders from a team member's account, bypassing trash for immediate removal
dropbox team member folder listDisplay all folders in each team member's account, useful for content auditing and storage analysis
dropbox team member folder replicationCopy folder contents from one team member to another's personal space, facilitating content transfer and backup
dropbox team member listDisplay comprehensive list of all team members with their status, roles, and account details
dropbox team member quota batch updateModify storage quotas for multiple team members in batch, managing storage allocation efficiently
dropbox team member quota listDisplay storage quota assignments for all team members, helping monitor and plan storage distribution
dropbox team member quota usageShow actual storage usage for each team member compared to their quotas, identifying storage needs
dropbox team member replicationReplicate all files from one team member's account to another, useful for account transitions or backups
dropbox team member suspendTemporarily suspend a team member's access to their account while preserving all data and settings
dropbox team member unsuspendRestore access for a suspended team member, reactivating their account and all associated permissions
dropbox team member update batch emailUpdate email addresses for multiple team members in batch, managing email changes efficiently
dropbox team member update batch externalidSet or update external IDs for multiple team members, integrating with identity management systems
dropbox team member update batch invisibleHide team members from the directory listing, enhancing privacy for sensitive roles or contractors
dropbox team member update batch profileUpdate profile information for multiple team members including names and job titles in batch
dropbox team member update batch visibleMake hidden team members visible in the directory, restoring standard visibility settings
dropbox team namespace file listDisplay comprehensive file and folder listings within team namespaces for content inventory and analysis
dropbox team namespace file sizeCalculate storage usage for files and folders in team namespaces, providing detailed size analytics
dropbox team namespace listDisplay all team namespaces including team folders and shared spaces with their configurations
dropbox team namespace member listShow all members with access to each namespace, detailing permissions and access levels
dropbox team namespace summaryGenerate comprehensive summary reports of team namespace usage, member counts, and storage statistics
dropbox team runas file batch copyCopy multiple files or folders on behalf of team members, useful for content management and organization
dropbox team runas file listList files and folders in a team member's account by running operations as that member
dropbox team runas file sync batch upUpload multiple local files to team members' Dropbox accounts in batch, running as those members
dropbox team runas sharedfolder batch leaveRemove team members from multiple shared folders in batch by running leave operations as those members
dropbox team runas sharedfolder batch shareShare multiple folders on behalf of team members in batch, automating folder sharing processes
dropbox team runas sharedfolder batch unshareRemove sharing from multiple folders on behalf of team members, managing folder access in bulk
dropbox team runas sharedfolder isolateRemove all shared folder access for a team member and transfer ownership, useful for departing employees
dropbox team runas sharedfolder listDisplay all shared folders accessible by a team member, running the operation as that member
dropbox team runas sharedfolder member batch addAdd multiple members to shared folders in batch on behalf of folder owners, streamlining access management
dropbox team runas sharedfolder member batch deleteRemove multiple members from shared folders in batch on behalf of folder owners, managing access efficiently
dropbox team runas sharedfolder mount addMount shared folders to team members' accounts on their behalf, ensuring proper folder synchronization
dropbox team runas sharedfolder mount deleteUnmount shared folders from team members' accounts on their behalf, managing folder synchronization
dropbox team runas sharedfolder mount listDisplay all shared folders currently mounted (synced) to a specific team member's account
dropbox team runas sharedfolder mount mountableShow all available shared folders that a team member can mount but hasn't synced yet
dropbox team sharedlink cap expiryApply expiration date limits to all team shared links for enhanced security and compliance
dropbox team sharedlink cap visibilityEnforce visibility restrictions on team shared links, controlling public access levels
dropbox team sharedlink delete linksDelete multiple shared links in batch for security compliance or access control cleanup
dropbox team sharedlink delete memberRemove all shared links created by a specific team member, useful for departing employees
dropbox team sharedlink listDisplay comprehensive list of all shared links created by team members with visibility and expiration details
dropbox team sharedlink update expiryModify expiration dates for existing shared links across the team to enforce security policies
dropbox team sharedlink update passwordAdd or change passwords on team shared links in batch for enhanced security protection
dropbox team sharedlink update visibilityChange access levels of existing shared links between public, team-only, and password-protected
dropbox team teamfolder addCreate a new team folder for centralized team content storage and collaboration
dropbox team teamfolder archiveArchive a team folder to make it read-only while preserving all content and access history
dropbox team teamfolder batch archiveArchive multiple team folders in batch, efficiently managing folder lifecycle and compliance
dropbox team teamfolder batch permdeletePermanently delete multiple archived team folders in batch, freeing storage space
dropbox team teamfolder batch replicationReplicate multiple team folders to another team account in batch for migration or backup
dropbox team teamfolder file listDisplay all files and subfolders within team folders for content inventory and management
dropbox team teamfolder file lock all releaseRelease all file locks within a team folder path, resolving editing conflicts in bulk
dropbox team teamfolder file lock listDisplay all locked files within team folders, identifying collaboration bottlenecks
dropbox team teamfolder file lock releaseRelease specific file locks in team folders to enable collaborative editing
dropbox team teamfolder file sizeCalculate storage usage for team folders, providing detailed size analytics for capacity planning
dropbox team teamfolder listDisplay all team folders with their status, sync settings, and member access information
dropbox team teamfolder member addAdd multiple users or groups to team folders in batch, streamlining access provisioning
dropbox team teamfolder member deleteRemove multiple users or groups from team folders in batch, managing access revocation efficiently
dropbox team teamfolder member listDisplay all members with access to each team folder, showing permission levels and access types
dropbox team teamfolder partial replicationSelectively replicate team folder contents to another team, enabling flexible content migration
dropbox team teamfolder permdeletePermanently delete an archived team folder and all its contents, irreversibly freeing storage
dropbox team teamfolder policy listDisplay all access policies and restrictions applied to team folders for governance review
dropbox team teamfolder replicationCopy an entire team folder with all contents to another team account for migration or backup
dropbox team teamfolder sync setting listDisplay sync configuration for all team folders, showing default sync behavior for members
dropbox team teamfolder sync setting updateModify sync settings for multiple team folders in batch, controlling automatic synchronization behavior

Figma

CommandDescription
figma account infoRetrieve current user information
figma file export all pageExport all files/pages under the team
figma file export frameExport all frames of the Figma file
figma file export nodeExport Figma document Node
figma file export pageExport all pages of the Figma file
figma file infoShow information of the Figma file
figma file listList files in the Figma Project
figma project listList projects of the team

GitHub

CommandDescription
github content getGet content metadata of the repository
github content putPut small text content into the repository
github issue listList issues of the public/private GitHub repository
github profileGet the authenticated user
github release asset downloadDownload assets
github release asset listList assets of GitHub Release
github release asset uploadUpload assets file into the GitHub Release
github release draftCreate release draft
github release listList releases
github tag createCreate a tag on the repository
util release installDownload & install watermint toolbox to the path

Utilities

CommandDescription
config auth deleteDelete existing auth credential
config auth listList all auth credentials
config feature disableDisable a feature.
config feature enableEnable a feature.
config feature listList available optional features.
config license installInstall a license key
config license listList available license keys
dropbox team insight report teamfoldermemberGenerate detailed reports on team folder membership, showing access patterns and member distribution
licenseShow license information
local file template applyApply file/folder structure template to the local path
local file template captureCapture file/folder structure as template from local path
log api jobShow statistics of the API log of the job specified by the job ID
log api nameShow statistics of the API log of the job specified by the job name
log cat curlFormat capture logs as curl sample
log cat jobRetrieve logs of specified Job ID
log cat kindConcatenate and print logs of specified log kind
log cat lastPrint the last job log files
log job archiveArchive jobs
log job deleteDelete old job history
log job listShow job history
util archive unzipExtract the zip archive file
util archive zipCompress target files into the zip archive
util cert selfsignedGenerate self-signed certificate and key
util database execExecute query on SQLite3 database file
util database queryQuery SQLite3 database
util date todayDisplay current date
util datetime nowDisplay current date/time
util decode base32Decode text from Base32 (RFC 4648) format
util decode base64Decode text from Base64 (RFC 4648) format
util desktop openOpen a file or folder with the default application
util encode base32Encode text into Base32 (RFC 4648) format
util encode base64Encode text into Base64 (RFC 4648) format
util feed jsonLoad feed from the URL and output the content as JSON
util file hashFile Hash
util git cloneClone git repository
util image exifPrint EXIF metadata of image file
util image placeholderCreate placeholder image
util json queryQuery JSON data
util net downloadDownload a file
util qrcode createCreate a QR code image file
util qrcode wifiGenerate QR code for WIFI configuration
util table format xlsxFormatting xlsx file into text
util text case downPrint lower case text
util text case upPrint upper case text
util text encoding fromConvert text encoding to UTF-8 text file from specified encoding.
util text encoding toConvert text encoding to specified encoding from UTF-8 text file.
util tidy move dispatchDispatch files
util tidy move simpleArchive local files
util time nowDisplay current time
util unixtime formatTime format to convert the unix time (epoch seconds from 1970-01-01)
util unixtime nowDisplay current time in unixtime
util uuid timestampUUID Timestamp
util uuid ulidULID Utility
util uuid v4Generate UUID v4 (random UUID)
util uuid v7Generate UUID v7
util uuid versionParse version and variant of UUID
util xlsx createCreate an empty spreadsheet
util xlsx sheet exportExport data from the xlsx file
util xlsx sheet importImport data into xlsx file
util xlsx sheet listList sheets of the xlsx file
versionShow version