### Install Taskuary with Python Source: https://taskuary.com/docs/index Install the core Python package and start the web interface. Requires Python 3.10 or newer. The browser opens automatically. ```bash pip install taskuary taskuary ``` -------------------------------- ### script.start Source: https://taskuary.com/docs/assistant-tools Starts a script by its name: walk me through my tasks | set up Taskuary | set up a report. Runs at once, with an undo on the receipt. ```APIDOC ## script.start ### Description Start a script by its name: walk me through my tasks | set up Taskuary | set up a report. Runs at once, with an undo on the receipt. ### Parameters #### Request Body - **name** (string) - Required - The name of the script. ### Behavior Runs at once, with an undo on the receipt. ``` -------------------------------- ### Install Taskuary with Desktop Support Source: https://taskuary.com/docs/index Install the optional desktop variant and launch the native desktop window instead of the browser. Requires Python 3.10 or newer. ```bash pip install "taskuary[desktop]" taskuary-desktop ``` -------------------------------- ### Run Taskuary Demo Source: https://taskuary.com/docs/index Starts a throwaway demo instance with invented work and scripted replies. Nothing can reach a real system; all data is kept in a temporary folder and resets on restart. ```bash taskuary --demo # or: docker compose --profile demo up ``` -------------------------------- ### GET /api/report-types Source: https://taskuary.com/docs/reports Lists every report type this install can run and whether its connection is ready. ```APIDOC ## GET /api/report-types ### Description Every type this install can run, and whether its connection is ready. ### Method GET ### Endpoint /api/report-types ``` -------------------------------- ### task.setup Source: https://taskuary.com/docs/assistant-tools Opens a walk-through with the assistant for a set-up that needs digging first. It requires text and a title. It waits for user confirmation on a card. ```APIDOC ## task.setup ### Description Opens a walk-through with the assistant for a set-up that needs digging first. It requires text and a title. It waits for user confirmation on a card. ### Method N/A (Assistant Tool) ### Endpoint N/A ### Parameters - **text** (string) - Required - The text for the setup. - **title** (string) - Required - A few words naming the job for the task list. ### Request Example { "text": "Example setup text", "title": "Example title" } ### Response Waits for user confirmation on a card. ``` -------------------------------- ### GET /api/intacct/fields?obj=APBILL Source: https://taskuary.com/docs/reports Returns the fields that the specified Intacct object carries in this company. ```APIDOC ## GET /api/intacct/fields?obj=APBILL ### Description What that object carries in this company. ### Method GET ### Endpoint /api/intacct/fields?obj=APBILL ``` -------------------------------- ### tools.list Source: https://taskuary.com/docs/assistant-tools Lists every tool in one bucket (table, task, agents, new, pipe, reports, app, look) and what each does and needs. Runs at once and changes nothing. ```APIDOC ## tools.list ### Description Lists every tool in one bucket (table, task, agents, new, pipe, reports, app, look) and what each does and needs. ### Method tools.list ### Parameters #### Query Parameters - **bucket** (string) - Optional - table, task, agents, new, pipe, reports, app, look ### Response Runs at once and changes nothing. ``` -------------------------------- ### docs.search Source: https://taskuary.com/docs/assistant-tools Searches Taskuary help pages and the owner's own documentation. Use for any 'how do I', 'what does X do', or 'why did it' questions about the app. Runs at once and changes nothing. ```APIDOC ## docs.search ### Description Searches Taskuary help pages and the owner's own documentation. Use for any 'how do I', 'what does X do', or 'why did it' questions about the app. Runs at once and changes nothing. ### Parameters - `query` (string) - Required - The words to search for. ### Response Returns matching documentation entries. ``` -------------------------------- ### Upgrade Taskuary via pip Source: https://taskuary.com/docs/index Run this command to upgrade the Python installation of Taskuary. The app will reopen after the upgrade, and connections and settings are preserved. ```bash pip install --upgrade taskuary ``` -------------------------------- ### pipe.list Source: https://taskuary.com/docs/assistant-tools Lists everything waiting on the owner, lane by lane, including replies, asks, approvals, stopped agents, and reports. Use for 'what's waiting', 'what's left', 'what do I have'. Runs at once and changes nothing. ```APIDOC ## pipe.list ### Description Lists everything waiting on the owner, lane by lane, including replies, asks, approvals, stopped agents, and reports. Use for 'what's waiting', 'what's left', 'what do I have'. Runs at once and changes nothing. ### Response Returns a structured list of items waiting on the owner. ``` -------------------------------- ### Run Taskuary with Docker Compose Source: https://taskuary.com/docs/index Clones the Taskuary repository and starts the container with Docker Compose. The container runs the web interface on localhost:7787 and stores data in the 'taskuary-data' volume. Set the TASKUARY_TOKEN environment variable before publishing the port. ```bash git clone https://github.com/ldbumble/taskuary cd taskuary docker compose up ``` -------------------------------- ### role.apply Source: https://taskuary.com/docs/assistant-tools Sets Taskuary up for the owner's job in one go - its worker, playbooks and daily workflow. Before calling, ASK the owner, one question at a time: the address of their bill-approval portal (`portal`; fine to leave out), and whether their own non-coding mail should go to that worker (`route_mail`: true or false - when they are only trying it out, false). The workflow is created OFF: after the yes, offer to run it once (report.run), and say they sign in to the portal themselves in the browser pane. Waits for confirmation on a card. ```APIDOC ## role.apply ### Description Set Taskuary up for the owner's job in one go - its worker, playbooks and daily workflow. Before calling, ASK the owner, one question at a time: the address of their bill-approval portal (`portal`; fine to leave out), and whether their own non-coding mail should go to that worker (`route_mail`: true or false - when they are only trying it out, false). The workflow is created OFF: after the yes, offer to run it once (report.run), and say they sign in to the portal themselves in the browser pane. Waits for your yes on a card. ### Parameters #### Request Body - **role** (string) - Required - The role to apply (e.g., ap for accounts payable). - **portal** (string) - Optional - The address of the bill-approval portal. - **route_mail** (boolean) - Optional - Whether the owner's non-coding mail should go to that worker. Default false when only trying it out. ### Behavior Waits for your yes on a card. ``` -------------------------------- ### repos.list Source: https://taskuary.com/docs/assistant-tools Lists the repositories a coding agent can work in, and what each one is for. Runs at once and changes nothing. ```APIDOC ## repos.list ### Description Lists the repositories a coding agent can work in, and what each one is for. ### Method repos.list ### Response Runs at once and changes nothing. ``` -------------------------------- ### connections.list Source: https://taskuary.com/docs/assistant-tools Lists every live connection, including name, type, key status, last sync, last error, and catalogue card issues. Runs at once and changes nothing. ```APIDOC ## connections.list ### Description Lists every live connection, including name, type, key status, last sync, last error, and catalogue card issues. Runs at once and changes nothing. ### Response Returns a list of connections with their details. ``` -------------------------------- ### connection.resume Source: https://taskuary.com/docs/assistant-tools Switches a connection back on. Runs at once, with an undo on the receipt. ```APIDOC ## connection.resume ### Description Switch a connection back on. Runs at once, with an undo on the receipt. ### Parameters #### Request Body - **name** (string) - Required - The name of the connection. ### Behavior Runs at once, with an undo on the receipt. ``` -------------------------------- ### settings.list Source: https://taskuary.com/docs/assistant-tools Lists settings in a group, or the groups themselves if no group is specified. Runs at once and changes nothing. ```APIDOC ## settings.list ### Description Lists settings in a group, or the groups themselves if no group is specified. Runs at once and changes nothing. ### Parameters - `group` (string) - Optional - The settings group to list. If omitted, returns the groups themselves and how many knobs each has. ### Response Returns settings or groups. ``` -------------------------------- ### setting.read Source: https://taskuary.com/docs/assistant-tools Reads a single setting, its value in words, and what it does. Runs at once and changes nothing. ```APIDOC ## setting.read ### Description Reads a single setting, its value in words, and what it does. Runs at once and changes nothing. ### Parameters - `key` (string) - Required - The setting key (or `label`): part of its name. ### Response Returns the setting's value and description. ``` -------------------------------- ### setting.set Source: https://taskuary.com/docs/assistant-tools Changes one setting; the schema says what it takes. Runs at once, with an undo on the receipt. ```APIDOC ## setting.set ### Description Change one setting; the schema says what it takes. Runs at once, with an undo on the receipt. ### Parameters #### Request Body - **setting** (string) - Required - Its key, or `label`: part of its name. - **value** (any) - Required - The new value for the setting. ### Behavior Runs at once, with an undo on the receipt. ``` -------------------------------- ### approvals.list Source: https://taskuary.com/docs/assistant-tools Lists everything waiting for the owner's approval, including drafted replies and proposed actions with their tasks. Runs at once and changes nothing. ```APIDOC ## approvals.list ### Description Lists everything waiting for the owner's approval, including drafted replies and proposed actions with their tasks. Runs at once and changes nothing. ### Response Returns a list of pending approvals. ``` -------------------------------- ### agents.now Source: https://taskuary.com/docs/assistant-tools Lists every agent session currently running, including its task, CLI, and status (working, idle, stuck, or asking the owner). Runs at once and changes nothing. ```APIDOC ## agents.now ### Description Lists every agent session currently running, including its task, CLI, and status (working, idle, stuck, or asking the owner). Runs at once and changes nothing. ### Response Returns a list of active agent sessions with their details. ```