List projects of the team
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 |
---|
Asana: (1) Access your name and email address. (2) Access your tasks, projects, and workspaces. (3) Create and modify tasks, projects, and comments on your behalf. |
For the first run, tbx
will ask you an authentication with your Asana (deprecated see #647) account.
Press the Enter key to launch the browser. The service then performs the authorization and tbx receives the results. You can close the browser window when you see the authentication success message.
watermint toolbox xx.x.xxx
==========================
© 2016-2024 Takayuki Okazaki
Licensed under open source licenses. Use the `license` command for more detail.
Opening the authorization URL:
https://app.asana.com/-/oauth_authorize?client_id=xxxxxxxxxxxxxxxx&redirect_uri=http%3A%2F%2Flocalhost%3A7800%2Fconnect%2Fauth&response_type=code&scope=default&state=xxxxxxxx
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 asana team project list
macOS, Linux:
$HOME/Desktop/tbx asana team project list
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 |
-team-name |
Name or GID of the team Filter by exact match to the name. | |
-team-name-prefix |
Name or GID of the team Filter by name match to the prefix. | |
-team-name-suffix |
Name or GID of the team Filter by name match to the suffix. | |
-workspace-name |
Name or GID of the workspace. Filter by exact match to the name. | |
-workspace-name-prefix |
Name or GID of the workspace. Filter by name match to the prefix. | |
-workspace-name-suffix |
Name or GID of the workspace. Filter by name match to the suffix. |
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 |
A project represents a prioritized list of tasks in Asana or a board with columns of tasks represented as cards.
The command will generate a report in three different formats. projects.csv
, projects.json
, and projects.xlsx
.
Column | Description |
---|---|
gid | Globally unique identifier of the resource, as a string. |
resource_type | The base type of this resource. |
name | Name of the project. |
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; projects_0000.xlsx
, projects_0001.xlsx
, projects_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.