Skip to Content
Skip to Content
Command reference

Command reference

Find commands by task, along with required inputs and key options.

General conventions

  • Organization commands use the selected organization. Add --org ORG_SLUG to specify one for a single request. Sign-in, local configuration, and PC tunnel connections use their own inputs.
  • Get IDs from list results. Names, organization slugs, and resource IDs are not interchangeable.
  • JSON and pagination options are available only on supported commands. For options beyond those listed here, check the command’s --help.
  • --force confirms deletion, removal, or leaving an organization. It does not bypass permissions or force a failed operation. You can also use -f.
  • admin is the CLI management group. Permissions depend on the resource and operation.
  • Account permissions and server availability still apply to commands shown in help. Switching to a development release does not remove these restrictions.

Top-level groups

GroupPurpose
auth, configSign-in and connection settings
orgOrganization selection and information
skill, agent, automationResource queries and management
chat, drive, integrationConversation, file, and integration queries
modelModel list
adminManagement groups: org, agent, skill, integration, usage, audit, tunnel
tunnelPC tunnel connection

admin skill github contains inspect, import, sync, and credentials. Under credentials, use set or clear. The executable command under tunnel is link.

Sign-in and connection settings

Installation, sign-in, refresh, and environment switching

CommandInputs and key optionsBehavior and notes
aipctl auth loginNoneSign in through a browser and select an organization. Complete the flow on the same PC.
aipctl auth logoutNoneRemoves local credentials. Does not cancel submitted tasks.
aipctl auth statusNoneShows saved sign-in state and expiration. Does not test server connectivity.
aipctl auth whoamiNoneRetrieves the current user from the server.
aipctl auth refreshNoneRefreshes the current authentication token. Sign in again if the session cannot be refreshed.
aipctl config set--app-url APP_URLSaves the service URL. A changed URL clears credentials and organization selection.
aipctl config statusNoneShows the service URL and settings saved on the PC.

Organizations

Select an organization · Organization guide

CommandInputs and key optionsBehavior and notes
aipctl org list[--json]Lists accessible organizations and slugs.
aipctl org currentNoneShows the saved default organization.
aipctl org useORG_SLUGSaves the default organization for subsequent commands.
aipctl org selectNoneSelects the default organization in a browser.
aipctl org members[--org ORG_SLUG]Lists members. Requires AI Operator permissions.
aipctl org capabilities[--org ORG_SLUG]Lists available organization features.
aipctl org settingsNoneShows current user settings. Does not edit organization settings.
aipctl org exit--force [--org ORG_SLUG]Leaves the specified organization. Check the organization first.

Skills

View, clone, transfer, and delete skills

CommandInputs and key optionsBehavior and notes
aipctl skill list[--search TEXT] [--json]Lists accessible skills.
aipctl skill getSKILL_ID [--json]Shows details and information for up to 10 files.
aipctl skill uploadFILE [--overwrite]Uploads .zip or .skill files. Use --overwrite only to replace the same name.
aipctl skill downloadSKILL_ID [-o FILE]Saves a downloadable organization skill. Overwrites the destination file.
aipctl skill deleteSKILL_ID --forceDeletes a skill after you verify the target.
aipctl skill library[--search TEXT]Lists shared library skills. Does not support --json.
aipctl skill cloneSKILL_ID [SKILL_ID ...]Clones up to five library skills. Check each result.
aipctl skill built-in[--search TEXT]Lists built-in skills. Requires AI Operator permissions.
aipctl skill clone-built-inSKILL_ID [SKILL_ID ...]Clones up to five built-in skills. Requires AI Operator permissions.

Agents

View agents and change enabled state

CommandInputs and key optionsBehavior and notes
aipctl agent list[--json]Lists installed agents.
aipctl agent getAGENT_ID [--json]Shows name, description, and required integrations.
aipctl agent enableAGENT_IDEnables an agent subject to policy and permissions.
aipctl agent disableAGENT_IDDisables an agent.
aipctl agent chat--agentId AGENT_ID -m MESSAGE [--json] or --conversation-id ID -m MESSAGE [--json]Starts or continues a conversation. Also accepts standard input. If the outcome is unclear, check conversation history before resending.

Automations

Creation, updates, and trigger examples

CommandInputs and key optionsBehavior and notes
aipctl automation list[--name TEXT] [--json]Filters by name or returns JSON. Lists the first 50 items with no next-page option.
aipctl automation getAUTOMATION_ID [--json]Shows saved settings. Secrets may not be fully displayed.
aipctl automation triggerswebhook --service-type SERVICE_TYPERetrieves webhook setup information. External mail and storage setup queries are restricted.
aipctl automation historyAUTOMATION_ID [--page N]Retrieves execution history by page.
aipctl automation createJSON_FILECreates schedule, webhook, or My Drive automations. Match the trigger type in the creation JSON.
aipctl automation updateAUTOMATION_ID JSON_FILEUpdates supported automations. Include fields you want to retain in the input file.
aipctl automation deleteAUTOMATION_ID --forceDeletes an automation.
aipctl automation enableAUTOMATION_IDEnables an automation. Its conditions may cause agent execution.
aipctl automation disableAUTOMATION_IDDisables an automation. Does not confirm cancellation of running tasks.
aipctl automation runAUTOMATION_IDRequests immediate execution. Check history for completion.
aipctl automation cancelAUTOMATION_ID SEQRequests cancellation by history sequence number. Check eligibility and final result.
aipctl automation webhook-regenAUTOMATION_ID [--show-sensitive]Regenerates the webhook URL. Output is masked by default; also update the sending service’s URL configuration.

--account-id and --folder-id in automation triggers help are for external services. Accepting these options does not mean the current server supports those services. Check trigger setup information and supported services.

Conversations and My Drive

File and conversation queries and limitations

CommandInputs and key optionsBehavior and notes
aipctl chat list[--json]Lists your conversations.
aipctl chat getCONVERSATION_IDShows your conversation details. No --json. Does not reproduce all web attachments, tags, or archived state.
aipctl chat messagesCONVERSATION_IDShows masked text, up to 500 characters per message. No --json.
aipctl drive listNoneLists My Drive items. No --json.
aipctl drive mkdirNAMECreates a root folder. No parent-folder option.
aipctl drive renameENTRY_ID NEW_NAMERenames a file or folder.
aipctl drive deleteENTRY_ID [ENTRY_ID ...] --forceDeletes one or more files or folders. Folder deletion affects descendants.
aipctl drive usageNoneShows storage usage.
aipctl drive uploadFILEUploads a local file to the root. Check the returned ID and list.
aipctl drive downloadENTRY_ID --output FILERequires a destination. Also accepts -o; overwrites existing destination files.

Integrations and models

Query integration, tool, and model information

CommandInputs and key optionsBehavior and notes
aipctl integration listNoneLists accessible integrations and policy status.
aipctl integration testINTEGRATION_IDRequests a connection test. Unsupported integrations may reject it.
aipctl model listNoneLists model IDs.

Organization members

Invite, change roles, and remove members

Organization management permissions and policies apply.

CommandInputs and key optionsBehavior and notes
aipctl admin org inviteEMAIL [EMAIL ...] [--role ROLE]Invites up to 100 addresses. Default role: member. Some invitations may fail.
aipctl admin org remove-memberEMAIL [EMAIL ...] --forceRemoves members after you check their current status.
aipctl admin org update-member-roleEMAIL [EMAIL ...] --role ROLEChanges roles. Values: owner, admin, aiOperator, member.

Organization agent management

Creation and update JSON, deletion, and export

AI Operator permissions and agent management policies apply.

CommandInputs and key optionsBehavior and notes
aipctl admin agent createJSON_FILECreates an agent from JSON. Check remaining settings and activation separately.
aipctl admin agent updateAGENT_ID JSON_FILEUpdates settings using JSON appropriate to the agent type.
aipctl admin agent deleteAGENT_ID --forceDeletes after you check dependencies.
aipctl admin agent shareAGENT_IDQueries sharing settings. Does not change sharing targets.
aipctl admin agent templatesNoneLists agent templates.
aipctl admin agent exportAGENT_ID [--output FILE]Saves YAML. Also accepts -o; defaults to AGENT_ID.yaml.

Organization skill management

Shared organization skills · GitHub import · PAT management

Requires AI Operator permissions.

CommandInputs and key optionsBehavior and notes
aipctl admin skill list[--search TEXT] [--page N] [--page-size N] [--json]Lists organization skills by page.
aipctl admin skill getSKILL_ID [--json]Shows skill details and GitHub connection information.
aipctl admin skill uploadFILE [--overwrite]Uploads an organization skill. Review whether to replace the same name.
aipctl admin skill downloadSKILL_ID [-o FILE]Downloads an organization skill. Overwrites destination files.
aipctl admin skill deleteSKILL_ID --forceDeletes an organization skill.
aipctl admin skill publishSKILL_IDPublishes to the library.
aipctl admin skill unpublishSKILL_IDRemoves library visibility.
aipctl admin skill built-in[--search TEXT]Lists built-in skills.
aipctl admin skill clone-built-inSKILL_ID [SKILL_ID ...]Clones up to five built-in skills. Check each result.
aipctl admin skill github inspectGITHUB_URL [--pat-env ENV_NAME] [--json]Shows repository and branch information.
aipctl admin skill github importGITHUB_URL [--pat-env ENV_NAME] [--overwrite] [--json]Imports organization skills from a repository or skill folder.
aipctl admin skill github syncSKILL_ID [--apply] [--json]Checks changes by default. Updates only with --apply.
aipctl admin skill github credentials setSKILL_ID --pat-env ENV_NAMESaves or changes the skill’s GitHub PAT. Pass the environment variable name.
aipctl admin skill github credentials clearSKILL_IDRemoves the saved PAT. Does not revoke the token on GitHub.

Integration management

Integration details and tool lists

Requires AI Operator permissions.

CommandInputs and key optionsBehavior and notes
aipctl admin integration availableNoneLists available integrations.
aipctl admin integration getINTEGRATION_IDShows detailed integration settings.
aipctl admin integration toolsINTEGRATION_IDShows tool names, descriptions, and policy status. Does not run tools.
aipctl admin integration updateINTEGRATION_ID JSON_FILEUpdates using the integration’s required JSON format. Do not pass raw query results.
aipctl admin integration deleteINTEGRATION_ID --forceDeletes after checking agents and presets that use it.

Usage and audit logs

Date, user, and event filters

Usage queries require organization administrator permissions. Audit logs require the appropriate plan and access. The default usage period is this month’s first day through today; use YYYY-MM-DD dates.

CommandInputs and key optionsBehavior and notes
aipctl admin usage credit[--start DATE] [--end DATE]Shows credit usage and user statistics for the period.
aipctl admin usage top-users[--start DATE] [--end DATE] [--limit N]Ranks user usage. Defaults to the top 10.
aipctl admin usage daily-graph[--start DATE] [--end DATE]Shows daily usage.
aipctl admin usage daily-users[--start DATE] [--end DATE] [--page N] [--user-id USER_ID]Shows daily user statistics, optionally filtered by user.
aipctl admin usage mcp-top[--start DATE] [--end DATE] [--limit N]Ranks MCP tool usage. Defaults to the top 10.
aipctl admin audit list[--type EVENT_TYPE] [--page N]Queries audit logs by event type and page.
aipctl admin audit typesNoneLists audit event type identifiers.

PC tunnel connection

Tunnel connection steps

Get a token from the web interface’s PC connection instructions. It is separate from sign-in for general management commands.

CommandInputs and key optionsBehavior and notes
aipctl tunnel linkCONNECTION_TOKENConnects the PC tunnel. Keep the process running while working; stop with Ctrl+C.
aipctl admin tunnel status[--org ORG_SLUG]Shows your connection status in the organization, not all organization connections.
aipctl admin tunnel config[--show-sensitive] [--org ORG_SLUG]Shows the connection command and connection counts. Secrets are masked by default.
aipctl admin tunnel token[--org ORG_SLUG]Requests token creation. Successful output does not display the token itself.

Output and failure handling

Append --help to a command to check its required inputs. Help does not execute the operation.

Last updated on