# Clanker Ship Documentation Clanker Ship is where people and clankers take a feature from a ticket to a plan, a pull request and proof that it works. These docs cover the website, the HTTP API and the MCP server that clankers connect to. ## Instructions for clankers - Pick the surface by who is calling. Scripts, CI and integrations call the HTTP API under `/v1` with a user or account API key (`ctk_…`), sent as `Authorization: Bearer ctk_…` or `X-API-Key: ctk_…`. Clankers such as Claude Code, Codex and Cursor connect to the MCP server at `/mcp` (here `https://api.clankership.com/mcp`) with clanker OAuth. - Never send an API key to MCP or `/clanker/v1`, and never send a clanker access token (`atk_…`) to `/v1`. Each MCP tool also answers at `POST /clanker/v1/…` with the same clanker token, for clankers that cannot speak MCP. - API hosts, from the OpenAPI document's `servers`: Production `https://api.clankership.com`, QA `https://api.qa.clankership.net`, Localhost `http://127.0.0.1:3200`. Call the API host, never the website or docs origin: they serve no `/v1`, MCP or OAuth routes. There is no sign-in endpoint on `/v1`; a person creates an API key under Security settings on the website. - The API does everything the website does, with the same permission checks. Use it instead of scraping the website. - Every page has a Markdown twin at its URL plus `.md` (the home page is `/index.md`), also served for `Accept: text/markdown`. [llms-full.txt](https://docs.clankership.com/llms-full.txt) has every page in one file. - The API contract is [openapi.json](https://docs.clankership.com/openapi.json) (OpenAPI 3.1). Every MCP tool with its input schema is in [mcp/tools.json](https://docs.clankership.com/mcp/tools.json). - A clanker grant is `read` (list and read) or `write` (change). Archive, remove and delete tools are destructive: confirm with the user first. - Before writing a ticket, a plan or tests, read the team's instructions with the `get_clanker_instructions` tool (or `POST /clanker/v1/clanker-instructions:get`), with `kind` `ticket`, `plan`, `test-cases`, `test-code`, `fixtures` or `test-ci`, every time. Do not cache a copy. - Manage secrets with the `clanker` CLI or the API; MCP has no secrets tools. Non-production pulls take a user or account API key; production pulls need a vault key (`ctvk_…`), which only pulls. Never send a vault key to MCP. Setting one value across several deployments at once is CLI and API only. ## Get started - [Clanker Ship documentation](https://docs.clankership.com/index.md): Clanker Ship is where people and their clankers plan software work, build it and prove it works. ### Start here - [Connect your clanker](https://docs.clankership.com/get-started/connect-your-clanker.md): Install the Clanker Ship plugin, sign your clanker in, make its first tool call and keep the plugin up to date. - [How Clanker Ship works](https://docs.clankership.com/get-started/how-it-works.md): The website, the API and the MCP server run the same services, with the same permission checks behind each. ### Concepts - [Workspaces and roles](https://docs.clankership.com/get-started/concepts/workspaces-and-roles.md): A workspace holds a company's work and people, and each member's role decides what they and their clankers can do. - [Products and environments](https://docs.clankership.com/get-started/concepts/products-and-environments.md): Products are what you test, environments are where they run, and a deployment joins one product to one environment. - [Planning](https://docs.clankership.com/get-started/concepts/planning.md): Teams, tickets, projects and views track the work; each status's documents, checklists and instructions say what it takes. - [Teams and tickets](https://docs.clankership.com/get-started/concepts/planning/tickets.md): Teams own and number tickets, and each ticket moves through its team's statuses with checklists, documents, tags, a person who owns it and the clankers working on it. - [Projects and milestones](https://docs.clankership.com/get-started/concepts/planning/projects.md): A project gathers tickets from one or more teams toward a goal, in numbered milestones and one priority order. - [Clanker instructions](https://docs.clankership.com/get-started/concepts/planning/clanker-instructions.md): Each status's instructions say what it asks of clankers; the other kinds hold new-ticket defaults and how clankers write tests. - [Clankers and messages](https://docs.clankership.com/get-started/concepts/clankers-and-messages.md): People send tickets to their clankers, and each message waits in the clanker's inbox until the clanker completes it. - [Pins](https://docs.clankership.com/get-started/concepts/pins.md): A pin is your own shortcut to a ticket, project, product, environment or team, listed in the website's sidebar in your order. - [Test runs](https://docs.clankership.com/get-started/concepts/test-runs.md): A test run is one clanker run of your Playwright specs, published to the workspace with every attempt and its evidence. - [Secrets vault and CLI](https://docs.clankership.com/get-started/concepts/secrets-vault.md): Keep each product's secrets per environment, manage them with the clanker CLI, and pull them when a deployment starts. ### Examples - [Publish test runs from CI](https://docs.clankership.com/get-started/examples/publish-test-runs-from-ci.md): Run your Playwright specs against a deployment on every push and publish the run, with a retry for flaky tests. - [Record a deployment from CI](https://docs.clankership.com/get-started/examples/record-a-deployment.md): Tell Clanker Ship which build is running after every deploy, with one API call from your pipeline. - [Create tickets from a script](https://docs.clankership.com/get-started/examples/create-tickets-from-a-script.md): Turn a list of work into tickets on a team, in a project and milestone, each with its Scope, without creating duplicates. - [Pull secrets in a deploy](https://docs.clankership.com/get-started/examples/pull-secrets-in-a-deploy.md): Load a deployment's secrets from the vault when the process starts, with a vault key in production. ## API reference - [API reference](https://docs.clankership.com/api.md): The Clanker Ship HTTP API does everything the website does, with JSON in and out and an API key on every request. - [Authentication](https://docs.clankership.com/api/authentication.md): Authenticate API requests with a user or account API key, sent as a bearer token or in the X-API-Key header. - [Errors](https://docs.clankership.com/api/errors.md): A failed request returns an HTTP status and a JSON body with one of six error tags and a message a person can act on. - [Pagination](https://docs.clankership.com/api/pagination.md): Most lists return everything in one response; test runs page with a cursor, secret versions with before, and two lists are capped. - [Request IDs](https://docs.clankership.com/api/request-ids.md): Each response carries an ID that finds the request in Clanker Ship's logs, so quote it when you report a problem. - [Idempotent requests](https://docs.clankership.com/api/idempotent-requests.md): Secret writes take a requestId, so a retry after a lost response returns the first result instead of writing twice. ### Account - [Profile](https://docs.clankership.com/api/profile.md): Your profile is the user an API key acts for: name, email address and photo, plus which emails you want. - [The User object](https://docs.clankership.com/api/profile/object.md): The person, or the workspace API key, the request acts for. - [Get your profile](https://docs.clankership.com/api/profile/get.md): Returns the user the API key acts for. - [Update your profile](https://docs.clankership.com/api/profile/update.md): Sets your display name and records a `profile.updated` event in each workspace you belong to. - [Upload a profile photo](https://docs.clankership.com/api/profile/upload-photo.md): Replaces your profile photo with a PNG, JPEG or WebP image under 5 MB. - [Get your notification preferences](https://docs.clankership.com/api/profile/get-preferences.md): Returns which emails you want, or the defaults if you never saved any. - [Update your notification preferences](https://docs.clankership.com/api/profile/update-preferences.md): Saves both email preferences, so send both fields. - [Get your home path](https://docs.clankership.com/api/profile/get-home.md): Returns the website path to open after sign-in: `/w/{slug}` for a workspace you belong to, or `/onboarding` when you belong to none. - [Get your onboarding](https://docs.clankership.com/api/profile/get-onboarding.md): Returns a workspace you already belong to, or `existing: null` when you belong to none, and the onboarding steps you finished. - [Complete an onboarding step](https://docs.clankership.com/api/profile/complete-onboarding-step.md): Marks one of your onboarding steps done, as Next does on the website. - [Skip onboarding](https://docs.clankership.com/api/profile/skip-onboarding.md): Ends your onboarding early, as Skip does on the website, so the website stops showing it. - [API keys](https://docs.clankership.com/api/api-keys.md): An API key lets scripts and tools call the API as you, with your role in each workspace. - [The ApiKey object](https://docs.clankership.com/api/api-keys/object.md): An API key that acts as you. - [List API keys](https://docs.clankership.com/api/api-keys/list.md): Returns your API keys that are not revoked, newest first. - [Create an API key](https://docs.clankership.com/api/api-keys/create.md): Creates an API key that acts as you and returns its secret, which is shown only this once. - [Revoke an API key](https://docs.clankership.com/api/api-keys/revoke.md): Revokes one of your API keys, so requests with it fail with Unauthorized from then on. - [CLI sign-ins](https://docs.clankership.com/api/cli-sessions.md): A CLI sign-in is one computer where `clanker auth login` signed in as you. - [The CliSession object](https://docs.clankership.com/api/cli-sessions/object.md): One computer where the `clanker` CLI signed in as you. - [List CLI sign-ins](https://docs.clankership.com/api/cli-sessions/list.md): Returns the computers where the `clanker` CLI is signed in as you. - [Revoke a CLI sign-in](https://docs.clankership.com/api/cli-sessions/revoke.md): Ends one of your CLI sign-ins, so the CLI on that computer must sign in again. ### Workspaces - [Workspaces](https://docs.clankership.com/api/workspaces.md): A workspace holds a company's products, environments, planning, test runs and secrets, and the people who work on them. - [The Workspace object](https://docs.clankership.com/api/workspaces/object.md): A workspace you belong to, with your role in it. - [List workspaces](https://docs.clankership.com/api/workspaces/list.md): Returns the workspaces you are an active member of, with your role in each. - [Create a workspace](https://docs.clankership.com/api/workspaces/create.md): Creates a workspace with you as its owner, plus the default ticket statuses and tags. - [Check a workspace slug](https://docs.clankership.com/api/workspaces/check-slug.md): Tells whether any workspace uses the slug, ignoring case. - [Get a workspace](https://docs.clankership.com/api/workspaces/get.md): Returns the workspace with its allowed domains and your role in it. - [Update a workspace](https://docs.clankership.com/api/workspaces/update.md): Sets the workspace's name, slug and allowed domains, and records a `workspace.updated` event. - [Check a new slug for a workspace](https://docs.clankership.com/api/workspaces/check-new-slug.md): Tells whether the workspace could change to the slug in `newSlug`, ignoring case. - [Upload a workspace icon](https://docs.clankership.com/api/workspaces/upload-icon.md): Replaces the workspace's icon with a PNG, JPEG or WebP image under 256 KB, and records a `workspace.icon_updated` event. - [List seeded workspaces](https://docs.clankership.com/api/workspaces/list-seeds.md): Returns the seeded local development workspace when this database has it, and whether you have joined it. - [Join a seeded workspace](https://docs.clankership.com/api/workspaces/join-seed.md): Makes you an owner of a seeded local development workspace. - [Members](https://docs.clankership.com/api/members.md): A member is a person in a workspace with one role: owner, admin, member or viewer. - [The Member object](https://docs.clankership.com/api/members/object.md): A person in the workspace and their role. - [List members](https://docs.clankership.com/api/members/list.md): Returns the workspace's active members with their roles and teams, sorted by name. - [Change a member's role](https://docs.clankership.com/api/members/update.md): Sets a member's role and records a `member.role_changed` event. - [Remove a member](https://docs.clankership.com/api/members/remove.md): Removes the person from the workspace and its teams, and records a `member.removed` event. - [List members with your role](https://docs.clankership.com/api/members/list-with-role.md): Returns the workspace's active members, plus your ID and role, so a client can tell which members you may manage. - [Invites](https://docs.clankership.com/api/invites.md): An invite asks one email address to join a workspace with a role and, optionally, teams. - [The Invite object](https://docs.clankership.com/api/invites/object.md): An invitation for one email address to join the workspace. - [Get an invite by token](https://docs.clankership.com/api/invites/get.md): Returns the invite a link points to, including expired, revoked and accepted ones, so a person can see which workspace invited them. - [List invites](https://docs.clankership.com/api/invites/list.md): Returns the workspace's open invites: those not accepted or revoked, including expired ones. - [Create invites](https://docs.clankership.com/api/invites/create.md): Invites each address with the same role and teams, queues an email with a link that expires in 7 days, and revokes any older open invite to that address. - [Revoke an invite](https://docs.clankership.com/api/invites/revoke.md): Cancels the invite so its link stops working, and records an `invite.revoked` event. - [Change an invite's role](https://docs.clankership.com/api/invites/update.md): Sets the role an open invite grants and records an `invite.role_changed` event. - [Resend an invite](https://docs.clankership.com/api/invites/resend.md): Queues a new email with a fresh link that expires in 7 days; the old link stops working. - [Accept an invite](https://docs.clankership.com/api/invites/accept.md): Adds you to the workspace with the invite's role and teams, and marks the invite accepted. - [Events](https://docs.clankership.com/api/events.md): An event records one change in a workspace, such as a role change, a new invite or a ticket update, and who made it: a person, a clanker acting for a person, or an account API key. - [The Event object](https://docs.clankership.com/api/events/object.md): One change in the workspace and who made it. - [List events](https://docs.clankership.com/api/events/list.md): Returns the 50 most recent events the caller can read, newest first, or one ticket's activity with `ticket`. - [Account API keys](https://docs.clankership.com/api/account-api-keys.md): An account API key (`ctk_…`) belongs to one workspace instead of a person, so CI and other automation can call the API. - [The AccountApiKey object](https://docs.clankership.com/api/account-api-keys/object.md): A workspace's API key that acts with a role instead of as a person. - [List account API keys](https://docs.clankership.com/api/account-api-keys/list.md): Returns the workspace's account API keys without their values. - [Create an account API key](https://docs.clankership.com/api/account-api-keys/create.md): Creates a key that acts in this workspace with the given role. - [Update an account API key](https://docs.clankership.com/api/account-api-keys/update.md): Changes the key's name and role; its value stays the same. - [Revoke an account API key](https://docs.clankership.com/api/account-api-keys/revoke.md): Revokes the key, so its next request fails with Unauthorized. - [Pins](https://docs.clankership.com/api/pins.md): A pin is a person's own shortcut to a ticket, project, product, environment or team, listed in the website's sidebar under Pinned in their order. - [The Pin object](https://docs.clankership.com/api/pins/object.md): One of the caller's pins: a shortcut to a ticket, project, product, environment or team, listed in the website's sidebar under Pinned. - [List your pins](https://docs.clankership.com/api/pins/list.md): Returns the caller's pins in the workspace, in their order. - [Pin something](https://docs.clankership.com/api/pins/create.md): Pins a ticket, project, product, environment or team the caller can open, after their other pins, and returns their pins. - [Unpin something](https://docs.clankership.com/api/pins/delete.md): Removes one of the caller's pins and returns the rest. - [Reorder a pin](https://docs.clankership.com/api/pins/reorder.md): Moves one of the caller's pins right before or right after another and returns them in the new order. ### Catalog - [Products](https://docs.clankership.com/api/products.md): A product is a piece of software the workspace builds and tests, such as a website, an API or a CLI. - [The Product object](https://docs.clankership.com/api/products/object.md): Software the workspace builds and tests. - [List products](https://docs.clankership.com/api/products/list.md): Returns the workspace's products with their active deployments. - [Create a product](https://docs.clankership.com/api/products/create.md): Adds a product to the workspace. - [Get a product](https://docs.clankership.com/api/products/get.md): Returns one product, archived or not, with its active deployments. - [Update a product](https://docs.clankership.com/api/products/update.md): Changes only the fields sent. - [Archive a product](https://docs.clankership.com/api/products/archive.md): Hides the product and refuses vault pulls for its deployments until it is restored. - [Restore a product](https://docs.clankership.com/api/products/restore.md): Brings an archived product back with its deployments and secrets. - [Environments](https://docs.clankership.com/api/environments.md): An environment is a place products run, such as staging or production. - [The Environment object](https://docs.clankership.com/api/environments/object.md): A place products run, shared by every product in the workspace. - [List environments](https://docs.clankership.com/api/environments/list.md): Returns the workspace's environments with the deployments of active products. - [Create an environment](https://docs.clankership.com/api/environments/create.md): Adds an environment every product in the workspace can deploy to. - [Get an environment](https://docs.clankership.com/api/environments/get.md): Returns one environment, archived or not, with the deployments of active products. - [Update an environment](https://docs.clankership.com/api/environments/update.md): Changes only the fields sent. - [Archive an environment](https://docs.clankership.com/api/environments/archive.md): Hides the environment and refuses vault pulls for its deployments until it is restored. - [Restore an environment](https://docs.clankership.com/api/environments/restore.md): Brings an archived environment back with its deployments. - [Deployments](https://docs.clankership.com/api/deployments.md): A deployment says that one product runs in one environment, at which URL and which version. - [The Deployment object](https://docs.clankership.com/api/deployments/object.md): One product running in one environment. - [List deployments](https://docs.clankership.com/api/deployments/list.md): Returns the workspace's deployments, optionally for one product or one environment. - [Create a deployment](https://docs.clankership.com/api/deployments/create.md): Records that a product runs in an environment. - [Get a deployment](https://docs.clankership.com/api/deployments/get.md): Returns the deployment of one product to one environment. - [Update a deployment](https://docs.clankership.com/api/deployments/update.md): Changes only the fields sent. - [Delete a deployment](https://docs.clankership.com/api/deployments/delete.md): Removes the deployment. ### Planning - [Teams](https://docs.clankership.com/api/teams.md): A team is a group of workspace members that owns tickets. - [The Team object](https://docs.clankership.com/api/teams/object.md): A group of workspace members that owns tickets and numbers them with its key, such as WEB-31. - [List teams](https://docs.clankership.com/api/teams/list.md): Returns open teams and the private teams the caller is in; owners, admins and account API keys see every team. - [Create a team](https://docs.clankership.com/api/teams/create.md): Owners and admins create teams. - [Get a team](https://docs.clankership.com/api/teams/get.md): Returns one team, archived or not, with its members. - [Update a team](https://docs.clankership.com/api/teams/update.md): Owners and admins change teams. - [Delete a team](https://docs.clankership.com/api/teams/delete.md): Owners and admins delete a team that has no tickets. - [Archive a team](https://docs.clankership.com/api/teams/archive.md): Owners and admins archive teams. - [Restore a team](https://docs.clankership.com/api/teams/restore.md): Owners and admins bring an archived team back, so its tickets take changes again. - [Join a team](https://docs.clankership.com/api/teams/join.md): Adds the caller to an open team. - [Add a team member](https://docs.clankership.com/api/teams/add-member.md): Adds a workspace member to the team, which is how private teams grow. - [Remove a team member](https://docs.clankership.com/api/teams/remove-member.md): Removes a person from the team. - [Projects](https://docs.clankership.com/api/projects.md): A project is a body of work with a goal, kept in one priority order per workspace. - [The Project object](https://docs.clankership.com/api/projects/object.md): A body of work with a goal. - [List projects](https://docs.clankership.com/api/projects/list.md): Returns the projects the caller can open, in priority order and without their documents. - [Create a project](https://docs.clankership.com/api/projects/create.md): Adds a project at the end of the priority order, with the default views. - [Get a project](https://docs.clankership.com/api/projects/get.md): Returns one project, archived or not, with its document and milestones. - [Update a project](https://docs.clankership.com/api/projects/update.md): Changes only the fields sent. - [Reorder a project](https://docs.clankership.com/api/projects/reorder.md): Moves the project in the workspace's priority order, right before or right after another project. - [Archive a project](https://docs.clankership.com/api/projects/archive.md): Archived projects leave lists and take no changes; their tickets stay on their teams. - [Restore a project](https://docs.clankership.com/api/projects/restore.md): Brings an archived project back, so it takes changes again. - [Milestones](https://docs.clankership.com/api/milestones.md): A milestone is a checkpoint within a project, numbered M1, M2 and so on. - [The Milestone object](https://docs.clankership.com/api/milestones/object.md): A checkpoint within a project, labeled M1, M2 and so on. - [Create a milestone](https://docs.clankership.com/api/milestones/create.md): Adds a milestone numbered one past the project's highest, such as M3 after M2. - [Update a milestone](https://docs.clankership.com/api/milestones/update.md): Changes only the fields sent. - [Delete a milestone](https://docs.clankership.com/api/milestones/delete.md): Deletes the milestone and takes it off its tickets, which stay in the project. - [Tickets](https://docs.clankership.com/api/tickets.md): A ticket is one unit of work on a team. - [The Ticket object](https://docs.clankership.com/api/tickets/object.md): One unit of work on a team, with its checklists and documents. - [List tickets](https://docs.clankership.com/api/tickets/list.md): Returns the tickets the caller can read, without their documents and checklists: tickets of the teams the caller sees, and tickets in the projects the caller can open. - [Create a ticket](https://docs.clankership.com/api/tickets/create.md): Adds a ticket with the team's next number, such as WEB-32, at the end of the workspace's ticket order. - [Get a ticket](https://docs.clankership.com/api/tickets/get.md): Returns one ticket with its checklists and the list of its documents, by its ID such as WEB-31. - [Update a ticket](https://docs.clankership.com/api/tickets/update.md): Changes only the fields sent. - [Move a ticket](https://docs.clankership.com/api/tickets/move.md): Moves the ticket to another team, where it takes the next number; its old ID keeps finding it. - [Reorder a ticket](https://docs.clankership.com/api/tickets/reorder.md): Places the ticket right before or after another in the one workspace-wide order that every view ordered by hand follows. - [Add checklist items](https://docs.clankership.com/api/tickets/add-checklist-item.md): Adds items, in order, to the end of the ticket's checklist for a status: all of them, or none. - [Update a checklist item](https://docs.clankership.com/api/tickets/update-checklist-item.md): Renames a ticket's checklist item, changes who does it, checks or clears it, or marks it in progress. - [Remove a checklist item](https://docs.clankership.com/api/tickets/remove-checklist-item.md): Removes an item from a ticket's checklist. - [Reorder a checklist item](https://docs.clankership.com/api/tickets/reorder-checklist-item.md): Moves a ticket's checklist item right before or after another item of the same checklist. - [Ask a question](https://docs.clankership.com/api/tickets/ask-question.md): Asks a question on a ticket, which then waits on a person until someone answers it; the ticket's owner is notified unless they asked. - [Answer a question](https://docs.clankership.com/api/tickets/answer-question.md): Answers an open question on a ticket. - [Link a branch](https://docs.clankership.com/api/tickets/link-branch.md): Links a ticket to a repository's branch it is worked on. - [Unlink a branch](https://docs.clankership.com/api/tickets/unlink-branch.md): Unlinks a repository's branch from a ticket. - [Link a pull request](https://docs.clankership.com/api/tickets/link-pull-request.md): Links a GitHub pull request to a ticket. - [Unlink a pull request](https://docs.clankership.com/api/tickets/unlink-pull-request.md): Unlinks a GitHub pull request from a ticket. - [Ticket documents](https://docs.clankership.com/api/ticket-documents.md): A ticket keeps a document for each of its team's statuses that keeps one: by default its Scope in Backlog, Plan in Plan, Build record in Build, Review in Review and Ship report in Ship. - [The TicketDocument object](https://docs.clankership.com/api/ticket-documents/object.md): A document a ticket keeps for one of its statuses, such as its Scope, Plan or Review. - [Get a document](https://docs.clankership.com/api/ticket-documents/get.md): Returns one of a ticket's documents in Markdown with its revision. - [Write a document](https://docs.clankership.com/api/ticket-documents/write.md): Replaces a document's Markdown as its next revision. - [Edit a document](https://docs.clankership.com/api/ticket-documents/edit.md): Replaces exact passages of a document as its next revision, all or none. - [List a document's revisions](https://docs.clankership.com/api/ticket-documents/revisions.md): Returns every revision of a ticket's document, newest first. - [Ticket statuses](https://docs.clankership.com/api/ticket-statuses.md): A ticket status is a step in a team's workflow, such as Plan or Build, in one of seven fixed categories, the stages every ticket moves through: backlog, plan, build, review, ship, done and canceled. - [The TicketStatus object](https://docs.clankership.com/api/ticket-statuses/object.md): A step in a team's workflow, such as Plan or Build. - [List ticket statuses](https://docs.clankership.com/api/ticket-statuses/list.md): Returns a team's statuses or, without `team`, the workspace's template that new teams copy, with each status's checklist template and instructions. - [Create a ticket status](https://docs.clankership.com/api/ticket-statuses/create.md): Owners and admins add statuses. - [Update a ticket status](https://docs.clankership.com/api/ticket-statuses/update.md): Owners and admins rename a status or make it the default. - [Delete a ticket status](https://docs.clankership.com/api/ticket-statuses/delete.md): Owners and admins delete statuses. - [Reorder a ticket status](https://docs.clankership.com/api/ticket-statuses/reorder.md): Moves a status right before or after another status of its category. - [Add a checklist template item](https://docs.clankership.com/api/ticket-statuses/create-checklist-item.md): Adds an item to the end of a status's checklist template, which holds up to 30 items. - [Update a checklist template item](https://docs.clankership.com/api/ticket-statuses/update-checklist-item.md): Renames an item of a status's checklist template, or changes who does it. - [Delete a checklist template item](https://docs.clankership.com/api/ticket-statuses/delete-checklist-item.md): Deletes an item from a status's checklist template. - [Reorder a checklist template item](https://docs.clankership.com/api/ticket-statuses/reorder-checklist-item.md): Moves a template item right before or after another. - [Get a status's instructions](https://docs.clankership.com/api/ticket-statuses/get-instructions.md): Returns what the status asks of a clanker, with its checklist template: the document its tickets keep there, the Markdown that document starts from, and how to work the status. - [Set a status's instructions](https://docs.clankership.com/api/ticket-statuses/set-instructions.md): Changes a status's instructions. - [Reset a status's instructions](https://docs.clankership.com/api/ticket-statuses/reset-instructions.md): Puts a status's instructions back to Clanker Ship's for its stage and returns them. - [Tags](https://docs.clankership.com/api/tags.md): A tag is a colored label on tickets, such as bug. - [The Tag object](https://docs.clankership.com/api/tags/object.md): A colored label on tickets. - [List tags](https://docs.clankership.com/api/tags/list.md): Returns workspace tags and the team tags of every team the caller sees or, with `team`, workspace tags and that team's tags. - [Create a tag](https://docs.clankership.com/api/tags/create.md): Owners and admins create workspace tags, and a team's members also create its team tags; viewers cannot. - [Update a tag](https://docs.clankership.com/api/tags/update.md): Renames or recolors a tag; only the fields sent change. - [Delete a tag](https://docs.clankership.com/api/tags/delete.md): Takes the tag off every ticket and out of saved view filters. - [Views](https://docs.clankership.com/api/views.md): A view is a saved way to look at tickets: filters, grouping, order and layout. - [The View object](https://docs.clankership.com/api/views/object.md): A saved way to look at a team's, a project's or a person's tickets: filters, grouping, order and layout. - [List your views](https://docs.clankership.com/api/views/list-mine.md): Returns the caller's own views, the tabs of their My work. - [Create one of your views](https://docs.clankership.com/api/views/create-mine.md): Saves a view of the tickets the caller can read, across every team, as a My work tab only they see. - [Get one of your views](https://docs.clankership.com/api/views/get-mine.md): Returns one of the caller's own views with the tickets it shows, in its order. - [Update one of your views](https://docs.clankership.com/api/views/update-mine.md): Changes only the settings sent; `filters` replaces the saved filters. - [Delete one of your views](https://docs.clankership.com/api/views/delete-mine.md): Deletes the view; it does not come back. - [Reorder one of your views](https://docs.clankership.com/api/views/reorder-mine.md): Moves the view right before or right after another of your views, changing the order of your My work tabs. - [List a team's views](https://docs.clankership.com/api/views/list-for-team.md): Returns the team's saved views. - [Create a team view](https://docs.clankership.com/api/views/create-for-team.md): Saves a view of the team's tickets, with a slug made from its name. - [Get a team view](https://docs.clankership.com/api/views/get-for-team.md): Returns the view with the tickets it shows, in its order, and the team's statuses for a status grouping's columns. - [Update a team view](https://docs.clankership.com/api/views/update-for-team.md): Changes only the settings sent, for everyone who opens the view; `filters` replaces the saved filters. - [Delete a team view](https://docs.clankership.com/api/views/delete-for-team.md): Deletes the view. - [Reorder a team view](https://docs.clankership.com/api/views/reorder-for-team.md): Moves the view right before or right after another of the team's views, changing the order of its tabs for everyone. - [List a project's views](https://docs.clankership.com/api/views/list-for-project.md): Returns the project's saved views. - [Create a project view](https://docs.clankership.com/api/views/create-for-project.md): Saves a view of the project's tickets, with a slug made from its name. - [Get a project view](https://docs.clankership.com/api/views/get-for-project.md): Returns the view with the tickets it shows, in its order. - [Update a project view](https://docs.clankership.com/api/views/update-for-project.md): Changes only the settings sent, for everyone who opens the view; `filters` replaces the saved filters. - [Delete a project view](https://docs.clankership.com/api/views/delete-for-project.md): Deletes the view. - [Reorder a project view](https://docs.clankership.com/api/views/reorder-for-project.md): Moves the view right before or right after another of the project's views, changing the order of its tabs for everyone. - [Clanker instructions](https://docs.clankership.com/api/clanker-instructions.md): Clanker instructions that no status holds: the defaults a clanker's new ticket gets, and how to write test cases, specs, a Fixture API and test CI. - [The ClankerInstructions object](https://docs.clankership.com/api/clanker-instructions/object.md): The instructions of one kind that a team's clankers follow, and where they come from. - [Get clanker instructions](https://docs.clankership.com/api/clanker-instructions/get.md): Returns the instructions a team's clankers follow: the team's own, else the workspace's, else Clanker Ship's defaults. - [Set clanker instructions](https://docs.clankership.com/api/clanker-instructions/set.md): Sets the workspace's or a team's own instructions. - [Reset clanker instructions](https://docs.clankership.com/api/clanker-instructions/reset.md): Removes the workspace's or a team's own instructions, so it follows what it inherits again, and returns the instructions that now apply. ### Clankers - [Clankers](https://docs.clankership.com/api/clankers.md): A clanker is one clanker client, such as Codex or Claude Code, working for one workspace member. - [The Clanker object](https://docs.clankership.com/api/clankers/object.md): A clanker: one clanker working for one workspace member. - [List clankers](https://docs.clankership.com/api/clankers/list.md): Returns the workspace's clankers with their computers and recent sessions. - [List your clankers with their work](https://docs.clankership.com/api/clankers/mine.md): Returns your clankers, as My clankers shows them: each with its computers, recent sessions and whether it is live, and the open tickets it works on. - [Register a clanker](https://docs.clankership.com/api/clankers/register.md): Registers your clanker for a client on one computer, creating the clanker on first use, and returns that computer's own clanker sign-in. - [Revoke a clanker](https://docs.clankership.com/api/clankers/revoke.md): Ends every sign-in of the clanker at once and declines the messages waiting in its inbox, notifying each sender. - [Get a clanker's settings](https://docs.clankership.com/api/clankers/get-settings.md): Returns one of your clankers' settings, with the defaults for those you never changed. - [Change a clanker's settings](https://docs.clankership.com/api/clankers/update-settings.md): Changes the settings given and returns them all. - [Clanker sessions](https://docs.clankership.com/api/clanker-sessions.md): A clanker session is one conversation in a clanker's app, such as a Claude Code session, on one of its computers. - [The SessionView object](https://docs.clankership.com/api/clanker-sessions/object.md): What Clanker Ship shows for a session: its ticket, where the ticket came from, the session's name and ticket line, and the person's other work. - [Get a session](https://docs.clankership.com/api/clanker-sessions/get.md): Returns one of your clankers' sessions as Clanker Ship shows it: its ticket and where the ticket came from, its name and ticket line, and your other open tickets. - [Pick a session's ticket](https://docs.clankership.com/api/clanker-sessions/set-ticket.md): Makes the ticket the session's picked ticket. - [Messages](https://docs.clankership.com/api/messages.md): A message is work for a clanker: a ticket with an ask, or a mention in a ticket comment. - [The ClankerMessage object](https://docs.clankership.com/api/messages/object.md): A ticket sent to a clanker with an ask, or a mention of the clanker in a ticket comment. - [Send a message](https://docs.clankership.com/api/messages/send.md): Sends a ticket to a clanker with an ask. - [List a ticket's messages](https://docs.clankership.com/api/messages/list.md): Returns every message sent about the ticket, with its status and the clanker's reply. - [Comments](https://docs.clankership.com/api/comments.md): A comment is Markdown on a ticket, written by a member or by a clanker working for one. - [The TicketComment object](https://docs.clankership.com/api/comments/object.md): A Markdown comment on a ticket, by a member or by a clanker working for one. - [List a ticket's comments](https://docs.clankership.com/api/comments/list.md): Returns the ticket's comments, oldest first. - [Create a comment](https://docs.clankership.com/api/comments/create.md): Adds a comment to the ticket and sends each mentioned clanker a message with the ask `mention`. - [Notifications](https://docs.clankership.com/api/notifications.md): A notification tells a member about a clanker message (one someone sent to their clanker, or the completion or decline of one they sent), a question someone asked on a ticket they own, or a ticket of theirs that only Human items hold up. - [The Notification object](https://docs.clankership.com/api/notifications/object.md): Tells a member about a clanker message, a question on a ticket they own, or a ticket of theirs that waits on Human items. - [List notifications](https://docs.clankership.com/api/notifications/list.md): Returns your notifications in the workspace, read and unread, each with its message. - [Mark notifications read](https://docs.clankership.com/api/notifications/mark-read.md): Marks every unread notification you have in the workspace as read. ### Testing - [Test runs](https://docs.clankership.com/api/test-runs.md): A test run is one run of a product's Playwright tests against its deployment in an environment, numbered per workspace, on one machine or split into shards across several. - [The TestRun object](https://docs.clankership.com/api/test-runs/object.md): A test run with its shards, its retries and every test with its attempts. - [List test runs](https://docs.clankership.com/api/test-runs/list.md): Returns the workspace's runs, newest first, 50 per page. - [Start a test run](https://docs.clankership.com/api/test-runs/start.md): Starts a shard of a `running` run of a product's deployment in an environment and records the deployment's URL and version. - [Get a test run](https://docs.clankership.com/api/test-runs/get.md): Returns one run with its shards, its retries and every test with its attempts. - [Finish a shard](https://docs.clankership.com/api/test-runs/finish-shard.md): Records the shard's tests with their first attempts and closes the shard. - [Start a retry](https://docs.clankership.com/api/test-runs/retry.md): Starts a retry of a finished run's failed tests and returns them with the URL to test. - [Finish a retry](https://docs.clankership.com/api/test-runs/finish-retry.md): Adds the retry's attempts to the run and recounts it. - [Semaphores](https://docs.clankership.com/api/semaphores.md): A semaphore limits how many tests use one shared resource at a time, such as a sandbox account or a rate-limited vendor API, across every worker and every run in the workspace. - [The Semaphore object](https://docs.clankership.com/api/semaphores/object.md): A named limit on how many tests may use a resource at once, with its holders. - [List semaphores](https://docs.clankership.com/api/semaphores/list.md): Returns each semaphore with its capacity and the leases held now. - [Fixture tokens](https://docs.clankership.com/api/fixture-tokens.md): A fixture token lets a test run create and delete test data through a deployment's Fixture API: routes in the product that make the records its tests need. - [The FixtureGrant object](https://docs.clankership.com/api/fixture-tokens/object.md): A scope and the fixture token that lets a test run create and delete data in it. - [Create a fixture token](https://docs.clankership.com/api/fixture-tokens/create.md): Returns a new scope and fixture token for a deployment's Fixture API without starting a run, for unpublished runs and conformance checks. ### Secrets - [Secrets](https://docs.clankership.com/api/secrets.md): A secret is a named value on a product, such as DATABASE_URL, with its own version history in each environment the product is deployed to. - [The Secret object](https://docs.clankership.com/api/secrets/object.md): A named value on a product with one version history per environment. - [List every product's secrets](https://docs.clankership.com/api/secrets/list-all.md): Returns each active product with the environments it is deployed to and each secret's current version there. - [List a product's secrets](https://docs.clankership.com/api/secrets/list.md): Returns the product's secrets with their current version in each environment the product is deployed to. - [Create a secret](https://docs.clankership.com/api/secrets/create.md): Adds a secret name to the product and sets any `values` sent, returning one result per value. - [Get a secret](https://docs.clankership.com/api/secrets/get.md): Returns the secret with its product, the environments the product is deployed to, and the current version in each. - [Update a secret](https://docs.clankership.com/api/secrets/update.md): Renames the secret, sets or clears values, or both, in one transaction, and returns one result per value sent. - [Delete a secret](https://docs.clankership.com/api/secrets/delete.md): Deletes the secret and every version of it in every environment. - [Set a secret across products and environments](https://docs.clankership.com/api/secrets/assign.md): Writes one value to every product and environment pair, up to 200 pairs, in one transaction, and creates the secret name on any product that lacks it. - [Generate a secret value](https://docs.clankership.com/api/secrets/generate.md): Generates one value per environment on the server and writes it to every selected product there, so products share a value within an environment and no value crosses environments. - [List a secret's versions](https://docs.clankership.com/api/secrets/list-versions.md): Returns up to 100 versions of the secret in one environment, newest first, with who wrote each. - [Restore a secret version](https://docs.clankership.com/api/secrets/restore-version.md): Writes a new version with an earlier version's value, generator and public key, and records which version it restored. - [Pull an environment's secrets](https://docs.clankership.com/api/secrets/pull.md): Returns the current value of every set secret for one deployment, keyed by secret name; the product and environment must be active. - [Vault keys](https://docs.clankership.com/api/vault-keys.md): A vault key (`ctvk_…`) lets a running deployment pull its production secrets. - [The VaultKey object](https://docs.clankership.com/api/vault-keys/object.md): A key that pulls production secrets for the products and environments it names. - [List vault keys](https://docs.clankership.com/api/vault-keys/list.md): Returns the workspace's vault keys without their values. - [Create a vault key](https://docs.clankership.com/api/vault-keys/create.md): Creates a key that can pull production secrets for the chosen products and production environments. - [Update a vault key](https://docs.clankership.com/api/vault-keys/update.md): Replaces the key's name and scope; its value stays the same. - [Revoke a vault key](https://docs.clankership.com/api/vault-keys/revoke.md): Revokes the key, so its next pull fails with Unauthorized. ### System - [Health](https://docs.clankership.com/api/system.md): Liveness checks that answer without an API key, outside the `/v1` prefix. - [Ping the API](https://docs.clankership.com/api/system/ping.md): Answers at the API's root while it is up. - [Check the API's health](https://docs.clankership.com/api/system/check.md): Answers while the API is up, for monitors and load balancers. ## MCP - [MCP reference](https://docs.clankership.com/mcp.md): Clankers connect to the Clanker Ship MCP server to read and change the workspace as the person who granted them access. - [Connect a client](https://docs.clankership.com/mcp/connect.md): Connect Claude Code, Codex, Cursor, VS Code or any MCP client to Clanker Ship with the plugin or the server URL. - [Permissions](https://docs.clankership.com/mcp/permissions.md): A clanker acts as the person who granted it, limited by the grant's read and write scopes and by that person's current role. - [MCP Apps](https://docs.clankership.com/mcp/apps.md): Clients that render MCP Apps draw My work, My clankers, a ticket, the inbox and plan files as screens inside the conversation; others get the same answer as text. - [Clanker HTTP API](https://docs.clankership.com/mcp/clanker-http.md): Every MCP tool has an HTTP twin under /clanker/v1 that takes the same JSON body and the same clanker access token. - [Codex extensions](https://docs.clankership.com/mcp/codex.md): In Codex and ChatGPT, Clanker Ship adds My work to the sidebar, a ticket panel to each thread, a plan viewer, ticket mentions and a settings page. - [Claude Code](https://docs.clankership.com/mcp/claude-code.md): In Claude Code, the Clanker Ship plugin names each session after its ticket, draws the ticket above the prompt with a pane for its checklist and your other work, and starts a turn with each new message. ### Catalog - [list_products](https://docs.clankership.com/mcp/tools/list_products.md): List the workspace's products, sorted by name. - [get_product](https://docs.clankership.com/mcp/tools/get_product.md): Get one product by slug, archived or not. - [create_product](https://docs.clankership.com/mcp/tools/create_product.md): Create a product: a piece of software the workspace tests, such as a website or an API. - [update_product](https://docs.clankership.com/mcp/tools/update_product.md): Change a product's slug, name, type, description or repository. - [archive_product](https://docs.clankership.com/mcp/tools/archive_product.md): Archive a product. - [restore_product](https://docs.clankership.com/mcp/tools/restore_product.md): Restore an archived product, so it and its deployments are active again. - [list_environments](https://docs.clankership.com/mcp/tools/list_environments.md): List the workspace's environments, sorted by name. - [get_environment](https://docs.clankership.com/mcp/tools/get_environment.md): Get one environment by slug, archived or not. - [create_environment](https://docs.clankership.com/mcp/tools/create_environment.md): Create an environment: a place products run, such as staging or production. - [update_environment](https://docs.clankership.com/mcp/tools/update_environment.md): Change an environment's slug, name, description or emoji. - [archive_environment](https://docs.clankership.com/mcp/tools/archive_environment.md): Archive an environment. - [restore_environment](https://docs.clankership.com/mcp/tools/restore_environment.md): Restore an archived environment, so it and its deployments are active again. - [list_deployments](https://docs.clankership.com/mcp/tools/list_deployments.md): List deployments, sorted by product name and then environment name, optionally for one product or one environment. - [get_deployment](https://docs.clankership.com/mcp/tools/get_deployment.md): Get one product's deployment to one environment. - [create_deployment](https://docs.clankership.com/mcp/tools/create_deployment.md): Deploy a product to an environment, with the URL where it answers, its Fixture API if it has one and the version running. - [update_deployment](https://docs.clankership.com/mcp/tools/update_deployment.md): Change a deployment's base URL, Fixture API URL or version. - [remove_deployment](https://docs.clankership.com/mcp/tools/remove_deployment.md): Remove a product's deployment to an environment. ### Planning - [list_teams](https://docs.clankership.com/mcp/tools/list_teams.md): List the workspace's teams, sorted by name: open teams and the private teams your person is in, or every team for workspace owners and admins. - [get_team](https://docs.clankership.com/mcp/tools/get_team.md): Get one team by key, with its members and whether your person joined it. - [create_team](https://docs.clankership.com/mcp/tools/create_team.md): Create a team. - [update_team](https://docs.clankership.com/mcp/tools/update_team.md): Change a team's name, key or visibility. - [join_team](https://docs.clankership.com/mcp/tools/join_team.md): Add your person to an open team. - [add_team_member](https://docs.clankership.com/mcp/tools/add_team_member.md): Add a workspace member to a team. - [remove_team_member](https://docs.clankership.com/mcp/tools/remove_team_member.md): Remove a member from a team. - [archive_team](https://docs.clankership.com/mcp/tools/archive_team.md): Archive a team. - [restore_team](https://docs.clankership.com/mcp/tools/restore_team.md): Restore an archived team, so its tickets take changes again. - [delete_team](https://docs.clankership.com/mcp/tools/delete_team.md): Delete a team that has no tickets, with its statuses, tags and views. - [list_ticket_statuses](https://docs.clankership.com/mcp/tools/list_ticket_statuses.md): List a team's ticket statuses, or, without a team, the workspace's template that new teams copy. - [create_ticket_status](https://docs.clankership.com/mcp/tools/create_ticket_status.md): Add a status to a team, or to the workspace's template that new teams copy, at the end of its stage. - [update_ticket_status](https://docs.clankership.com/mcp/tools/update_ticket_status.md): Rename a status, or make a Backlog status the one new tickets get. - [reorder_ticket_status](https://docs.clankership.com/mcp/tools/reorder_ticket_status.md): Move a status before or after another status of the same stage. - [delete_ticket_status](https://docs.clankership.com/mcp/tools/delete_ticket_status.md): Delete a status. - [add_status_checklist_item](https://docs.clankership.com/mcp/tools/add_status_checklist_item.md): Add an item to the end of a status's checklist template, the list a ticket's checklist starts from when it enters the status. - [update_status_checklist_item](https://docs.clankership.com/mcp/tools/update_status_checklist_item.md): Rename a status's checklist template item, or change who does it. - [reorder_status_checklist_item](https://docs.clankership.com/mcp/tools/reorder_status_checklist_item.md): Move a status's checklist template item before or after another of its items. - [remove_status_checklist_item](https://docs.clankership.com/mcp/tools/remove_status_checklist_item.md): Delete an item from a status's checklist template. - [list_tags](https://docs.clankership.com/mcp/tools/list_tags.md): List workspace tags and the tags of the teams your person sees, or, with a team, the tags its tickets can use: workspace tags and the team's own. - [create_tag](https://docs.clankership.com/mcp/tools/create_tag.md): Create a workspace tag, or a team's own tag with team. - [update_tag](https://docs.clankership.com/mcp/tools/update_tag.md): Rename or recolor a tag. - [delete_tag](https://docs.clankership.com/mcp/tools/delete_tag.md): Delete a tag. - [list_projects](https://docs.clankership.com/mcp/tools/list_projects.md): List the projects your person can open, in priority order, optionally for one team or one product. - [get_project](https://docs.clankership.com/mcp/tools/get_project.md): Get one project with its teams, products, milestones, ticket counts by status category and Markdown document. - [create_project](https://docs.clankership.com/mcp/tools/create_project.md): Create a project for one or more teams; only those teams' tickets can join it. - [update_project](https://docs.clankership.com/mcp/tools/update_project.md): Change a project. - [reorder_project](https://docs.clankership.com/mcp/tools/reorder_project.md): Move a project in the workspace's priority order: right before or after another project, or first with after null. - [archive_project](https://docs.clankership.com/mcp/tools/archive_project.md): Archive a project. - [restore_project](https://docs.clankership.com/mcp/tools/restore_project.md): Restore an archived project so it can change again. - [create_milestone](https://docs.clankership.com/mcp/tools/create_milestone.md): Add a milestone to a project that is not archived. - [update_milestone](https://docs.clankership.com/mcp/tools/update_milestone.md): Change a milestone's name or summary. - [delete_milestone](https://docs.clankership.com/mcp/tools/delete_milestone.md): Delete a milestone. - [list_tickets](https://docs.clankership.com/mcp/tools/list_tickets.md): List the tickets your person can read, without their checklists and documents, optionally for one team or project, one owner, one clanker, some status categories, words in the title or Scope, or only those that need a human. - [get_ticket](https://docs.clankership.com/mcp/tools/get_ticket.md): Get one ticket with its creator, former IDs, checklists, documents, branches and pull requests. - [create_ticket](https://docs.clankership.com/mcp/tools/create_ticket.md): Create a ticket on a team, with the next ID. - [update_ticket](https://docs.clankership.com/mcp/tools/update_ticket.md): Change a ticket: its title, status, owner, clankers, project, milestone or tags. - [move_ticket](https://docs.clankership.com/mcp/tools/move_ticket.md): Move a ticket to another team. - [reorder_ticket](https://docs.clankership.com/mcp/tools/reorder_ticket.md): Move a ticket right before or after another in the one workspace-wide order that every view ordered by hand follows. - [add_checklist_item](https://docs.clankership.com/mcp/tools/add_checklist_item.md): Add items, in order, to the end of a ticket's checklist for one of its team's statuses, its current status unless you name another: all of them, or none. - [update_checklist_item](https://docs.clankership.com/mcp/tools/update_checklist_item.md): Check, clear, start, rename or retag an item of a ticket's checklist. - [reorder_checklist_item](https://docs.clankership.com/mcp/tools/reorder_checklist_item.md): Move an item of a ticket's checklist right before or after another item of the same checklist. - [remove_checklist_item](https://docs.clankership.com/mcp/tools/remove_checklist_item.md): Remove an item from a ticket's checklist. - [ask_human](https://docs.clankership.com/mcp/tools/ask_human.md): Ask a question on a ticket when you need a decision you cannot make yourself, such as a choice between two designs or a missing requirement. - [answer_question](https://docs.clankership.com/mcp/tools/answer_question.md): Record your person's answer to an open question on a ticket, in their words from your conversation, when they answer it there instead of on the ticket page. - [link_ticket_branch](https://docs.clankership.com/mcp/tools/link_ticket_branch.md): Link a ticket to the repository's branch you work on it in, so the plugin's hook names the ticket in sessions on that branch, Codex's thread panel opens on it, and the ticket page lists the branch. - [unlink_ticket_branch](https://docs.clankership.com/mcp/tools/unlink_ticket_branch.md): Unlink a repository's branch from a ticket, such as one linked by mistake. - [link_ticket_pull_request](https://docs.clankership.com/mcp/tools/link_ticket_pull_request.md): Link a GitHub pull request to a ticket, so the ticket page lists it and Review and Ship merge and follow it. - [unlink_ticket_pull_request](https://docs.clankership.com/mcp/tools/unlink_ticket_pull_request.md): Unlink a GitHub pull request from a ticket, such as one closed for a new pull request or linked by mistake. - [list_views](https://docs.clankership.com/mcp/tools/list_views.md): List a team's, a project's or your person's own saved views, the default view first. - [get_view](https://docs.clankership.com/mcp/tools/get_view.md): Get a view with its tickets in its order, such as a team's Active view. - [create_view](https://docs.clankership.com/mcp/tools/create_view.md): Save a view for a team, a project, or your person's My work with mine: true: filters, grouping, order and layout. - [update_view](https://docs.clankership.com/mcp/tools/update_view.md): Change a view for everyone, or make it the default. - [delete_view](https://docs.clankership.com/mcp/tools/delete_view.md): Delete a view that is not the default; make another view the default first. - [reorder_view](https://docs.clankership.com/mcp/tools/reorder_view.md): Move a view right before or after another view of the same team, project or your own, changing the order of those tabs for everyone who sees them. - [get_clanker_instructions](https://docs.clankership.com/mcp/tools/get_clanker_instructions.md): Get the instructions to follow. - [update_clanker_instructions](https://docs.clankership.com/mcp/tools/update_clanker_instructions.md): Change instructions. - [reset_clanker_instructions](https://docs.clankership.com/mcp/tools/reset_clanker_instructions.md): Put instructions back to what they inherit. - [get_document](https://docs.clankership.com/mcp/tools/get_document.md): Read one of a ticket's documents, such as its Scope or Plan, in Markdown with its revision. - [write_document](https://docs.clankership.com/mcp/tools/write_document.md): Write a ticket's document whole, as its next revision, such as the first draft of its Scope or Plan. - [edit_document](https://docs.clankership.com/mcp/tools/edit_document.md): Change passages of a ticket's document as its next revision, all or none. - [list_document_revisions](https://docs.clankership.com/mcp/tools/list_document_revisions.md): List every revision of a ticket's document, newest first, with who wrote each. ### Pins - [list_pins](https://docs.clankership.com/mcp/tools/list_pins.md): List your person's pins in their order: the shortcuts in their website sidebar under Pinned. - [create_pin](https://docs.clankership.com/mcp/tools/create_pin.md): Pin a ticket, project, product, environment or team for your person, such as the ticket you are working on. - [delete_pin](https://docs.clankership.com/mcp/tools/delete_pin.md): Unpin a ticket, project, product, environment or team from your person's sidebar. - [reorder_pin](https://docs.clankership.com/mcp/tools/reorder_pin.md): Move one of your person's pins right before or after another. ### Messages - [list_messages](https://docs.clankership.com/mcp/tools/list_messages.md): List the messages people sent you: a ticket with an ask, such as Draft the ticket, a mention in a ticket comment, or the answer to a question you asked with ask_human. - [get_message](https://docs.clankership.com/mcp/tools/get_message.md): Get one of your messages: its ticket, ask, note, sender, status and reply. - [complete_message](https://docs.clankership.com/mcp/tools/complete_message.md): Mark a message done once the work it asked for is done. - [list_comments](https://docs.clankership.com/mcp/tools/list_comments.md): List a ticket's comments, oldest first. - [comment_on_ticket](https://docs.clankership.com/mcp/tools/comment_on_ticket.md): Reply on a ticket with a Markdown comment, such as an answer to a mention. - [list_ticket_messages](https://docs.clankership.com/mcp/tools/list_ticket_messages.md): List the messages people and clankers sent clankers about a ticket, newest first: each one's clanker, ask, note, sender, status and reply, as the ticket page shows them. - [send_ticket](https://docs.clankership.com/mcp/tools/send_ticket.md): Send a ticket to another clanker with an ask, such as Codex to build what you planned. - [list_clankers](https://docs.clankership.com/mcp/tools/list_clankers.md): List the workspace's clankers that can work on tickets, or one person's: clankers that are not revoked and work for an active member. - [revoke_clanker](https://docs.clankership.com/mcp/tools/revoke_clanker.md): Revoke one of your person's other clankers, such as one on a computer they no longer use. - [list_notifications](https://docs.clankership.com/mcp/tools/list_notifications.md): List your person's 100 newest notifications, newest first, read and unread: messages to their clankers, completed or declined messages they sent, questions asked on tickets they own, and tickets of theirs that wait on them for Human items. - [mark_notifications_read](https://docs.clankership.com/mcp/tools/mark_notifications_read.md): Mark every unread notification of your person's read, as the website's Notifications page does when they open it. - [set_session_ticket](https://docs.clankership.com/mcp/tools/set_session_ticket.md): Pick the ticket one of your person's sessions works on, by the session's ID from show_clankers. ### Activity - [list_events](https://docs.clankership.com/mcp/tools/list_events.md): List the latest 50 events your person may see, newest first, or one ticket's activity with ticket: each change, who made it (a person, a clanker for its person, or an account API key) and what it was about. ### Test runs - [list_test_runs](https://docs.clankership.com/mcp/tools/list_test_runs.md): List published test runs, newest first, 50 at a time: each run's number, product, environment, commit, branch, result and counts. - [get_test_run](https://docs.clankership.com/mcp/tools/get_test_run.md): Get one test run by number: its deployment, commit, shards, retries, and every test with each attempt's result, error and evidence links. - [list_semaphores](https://docs.clankership.com/mcp/tools/list_semaphores.md): List the workspace's semaphores, the shared resources test runs take turns on: each one's capacity and the leases held now, with the run, retry and test holding each. ### Workspace - [get_workspace](https://docs.clankership.com/mcp/tools/get_workspace.md): Get the workspace you work in: its name, slug, icon and allowed email domains, and your person's role in it. - [update_workspace](https://docs.clankership.com/mcp/tools/update_workspace.md): Change the workspace's name, slug or allowed email domains. - [list_members](https://docs.clankership.com/mcp/tools/list_members.md): List the workspace's active members with their names, emails, roles and teams, such as to name a ticket's owner by email. - [update_member](https://docs.clankership.com/mcp/tools/update_member.md): Change a member's role. - [remove_member](https://docs.clankership.com/mcp/tools/remove_member.md): Remove a member from the workspace and its teams. - [list_invites](https://docs.clankership.com/mcp/tools/list_invites.md): List the workspace's open invites: each one's email, role, teams and when it was sent. - [create_invites](https://docs.clankership.com/mcp/tools/create_invites.md): Invite people to the workspace by email, with a role and the teams they join on accepting. - [update_invite](https://docs.clankership.com/mcp/tools/update_invite.md): Change the role an open invite grants. - [resend_invite](https://docs.clankership.com/mcp/tools/resend_invite.md): Send an open invite's email again. - [revoke_invite](https://docs.clankership.com/mcp/tools/revoke_invite.md): Revoke an open invite, so its link stops working. - [get_profile](https://docs.clankership.com/mcp/tools/get_profile.md): Get your person's profile: their user ID, name, email and photo. - [update_profile](https://docs.clankership.com/mcp/tools/update_profile.md): Change your person's name, as every workspace shows it. - [get_preferences](https://docs.clankership.com/mcp/tools/get_preferences.md): Get your person's email preferences: product updates, and a digest of workspace activity. - [update_preferences](https://docs.clankership.com/mcp/tools/update_preferences.md): Change your person's email preferences. - [get_onboarding](https://docs.clankership.com/mcp/tools/get_onboarding.md): Get your person's onboarding: the steps they finished, of install-plugin, sign-in, create-ticket, invite-team, and whether they finished or skipped it. - [complete_onboarding_step](https://docs.clankership.com/mcp/tools/complete_onboarding_step.md): Mark one of your person's onboarding steps done, such as install-plugin once the plugin runs. - [skip_onboarding](https://docs.clankership.com/mcp/tools/skip_onboarding.md): End your person's onboarding early, as Skip does on the website. ### Keys - [list_api_keys](https://docs.clankership.com/mcp/tools/list_api_keys.md): List your person's API keys: each one's name, the start and last four characters of its token, and when it was made and last used. - [revoke_api_key](https://docs.clankership.com/mcp/tools/revoke_api_key.md): Revoke one of your person's API keys. - [list_account_keys](https://docs.clankership.com/mcp/tools/list_account_keys.md): List the workspace's account API keys: keys for scripts and CI that act with a role instead of a person. - [update_account_key](https://docs.clankership.com/mcp/tools/update_account_key.md): Rename an account API key or change its role. - [revoke_account_key](https://docs.clankership.com/mcp/tools/revoke_account_key.md): Revoke an account API key. - [list_cli_sessions](https://docs.clankership.com/mcp/tools/list_cli_sessions.md): List your person's CLI sign-ins: the computers where `clanker auth login` signed them in, with when each started and expires. - [revoke_cli_session](https://docs.clankership.com/mcp/tools/revoke_cli_session.md): End one of your person's CLI sign-ins, such as on a computer they no longer use. ### Vault - [list_secrets](https://docs.clankership.com/mcp/tools/list_secrets.md): List the secrets of every active product, or one product's: each secret's name and, for each environment the product is deployed to, whether it has a value and its current version. - [create_secret](https://docs.clankership.com/mcp/tools/create_secret.md): Define a secret's name on a product, with no value yet; people set values on the website or with the CLI, or generate_secret makes one. - [update_secret](https://docs.clankership.com/mcp/tools/update_secret.md): Rename a secret, or clear its value in some environments. - [delete_secret](https://docs.clankership.com/mcp/tools/delete_secret.md): Delete a secret from a product, with every environment's values and versions. - [generate_secret](https://docs.clankership.com/mcp/tools/generate_secret.md): Generate a new value on the server for a secret in each product and environment given, such as to rotate a token, creating the name where it is missing. - [list_secret_versions](https://docs.clankership.com/mcp/tools/list_secret_versions.md): List a secret's versions in one environment, newest first, 100 at a time: each version's number, whether it holds a value, who wrote it and when. - [restore_secret_version](https://docs.clankership.com/mcp/tools/restore_secret_version.md): Restore an earlier version of a secret in one environment, as its newest version. - [list_vault_keys](https://docs.clankership.com/mcp/tools/list_vault_keys.md): List the workspace's vault keys: keys a deployed product uses to pull production secrets, each with its name, the products and environments it may pull, and when it was made. - [update_vault_key](https://docs.clankership.com/mcp/tools/update_vault_key.md): Replace a vault key's name and the products and production environments it may pull from; its token stays the same. - [revoke_vault_key](https://docs.clankership.com/mcp/tools/revoke_vault_key.md): Revoke a vault key. ### Screens - [show_work](https://docs.clankership.com/mcp/tools/show_work.md): Show your person's My work: the tickets of their default My work view, which starts as the open tickets they own or their clankers work on, grouped by status with work under way first. - [show_clankers](https://docs.clankership.com/mcp/tools/show_clankers.md): Show your person's My clankers: each of their clankers, whether it is live, its live sessions with each one's ID, where it works and its ticket, and the open tickets it works on. - [show_ticket](https://docs.clankership.com/mcp/tools/show_ticket.md): Show one ticket: its status, owner, clankers, checklists, pull requests and the document its current status keeps. - [open_ticket_panel](https://docs.clankership.com/mcp/tools/open_ticket_panel.md): Open a thread's ticket panel: the ticket the branch of your most recent live session works on, as the plugin's hook names it (the oldest ticket linked to the branch, else the one whose ID the branch name carries), or your person's open tickets to pick from. - [show_inbox](https://docs.clankership.com/mcp/tools/show_inbox.md): Show your open messages: tickets people sent you with an ask, mentions in comments, and answers to your questions. - [open_plan_file](https://docs.clankership.com/mcp/tools/open_plan_file.md): Open a local .plan.md file in the plan viewer, with the ticket its name gives, such as WEB-31.plan.md. ### Codex - [search_tickets](https://docs.clankership.com/mcp/tools/search_tickets.md): Find tickets whose ID starts with the query or whose title or Scope contains it, open tickets first, and projects whose name or slug contains it, such as for an @-mention. - [read_settings](https://docs.clankership.com/mcp/tools/read_settings.md): Read your settings: your default team for new tickets, and whether new messages wake an idle Codex thread. - [update_settings](https://docs.clankership.com/mcp/tools/update_settings.md): Change your settings. ## CLI reference - [CLI reference](https://docs.clankership.com/cli.md): Every clanker command, with its arguments, options and examples, built from the CLI itself. ### run - [clanker run](https://docs.clankership.com/cli/run.md): Run the project's Playwright specs and publish the run to the workspace ### retry - [clanker retry](https://docs.clankership.com/cli/retry.md): Run a published run's failed tests again on the same commit; tests that pass every attempt count as flaky ### update - [clanker update](https://docs.clankership.com/cli/update.md): Update the Clanker CLI now, or turn automatic updates on or off ### install-deps - [clanker install-deps](https://docs.clankership.com/cli/install-deps.md): Install the system libraries Chrome needs on Linux (asks for sudo) ### auth - [clanker auth login](https://docs.clankership.com/cli/auth/login.md): Sign this computer in through the website, or save an API key from stdin - [clanker auth logout](https://docs.clankership.com/cli/auth/logout.md): Sign this computer out and end its CLI sign-in - [clanker auth whoami](https://docs.clankership.com/cli/auth/whoami.md): Show who the CLI acts as: your name, email and photo - [clanker auth sessions](https://docs.clankership.com/cli/auth/sessions.md): List the computers where the CLI is signed in as you - [clanker auth revoke](https://docs.clankership.com/cli/auth/revoke.md): End a CLI sign-in on another computer, by its ID from auth sessions ### link - [clanker link](https://docs.clankership.com/cli/link.md): Link this repository to a workspace so commands use it by default ### unlink - [clanker unlink](https://docs.clankership.com/cli/unlink.md): Remove this repository's workspace link ### product - [clanker product list](https://docs.clankership.com/cli/product/list.md): List products - [clanker product get](https://docs.clankership.com/cli/product/get.md): Show a product, archived or not - [clanker product create](https://docs.clankership.com/cli/product/create.md): Create a product - [clanker product update](https://docs.clankership.com/cli/product/update.md): Change a product's slug, name, type or description - [clanker product archive](https://docs.clankership.com/cli/product/archive.md): Archive a product until it is restored. - [clanker product restore](https://docs.clankership.com/cli/product/restore.md): Restore an archived product ### environment - [clanker environment list](https://docs.clankership.com/cli/environment/list.md): List environments - [clanker environment get](https://docs.clankership.com/cli/environment/get.md): Show an environment, archived or not - [clanker environment create](https://docs.clankership.com/cli/environment/create.md): Create an environment - [clanker environment update](https://docs.clankership.com/cli/environment/update.md): Change an environment's slug, name, description or emoji. - [clanker environment archive](https://docs.clankership.com/cli/environment/archive.md): Archive an environment until it is restored. - [clanker environment restore](https://docs.clankership.com/cli/environment/restore.md): Restore an archived environment ### deployment - [clanker deployment list](https://docs.clankership.com/cli/deployment/list.md): List deployments - [clanker deployment get](https://docs.clankership.com/cli/deployment/get.md): Show a product's deployment to an environment - [clanker deployment create](https://docs.clankership.com/cli/deployment/create.md): Deploy a product to an environment - [clanker deployment update](https://docs.clankership.com/cli/deployment/update.md): Change a deployment's base URL or fixture URL, or record the version running after a deploy - [clanker deployment remove](https://docs.clankership.com/cli/deployment/remove.md): Remove a deployment. ### fixtures - [clanker fixtures check](https://docs.clankership.com/cli/fixtures/check.md): Create every fixture in the manifest from its example, delete the scope, and fail if anything is left ### semaphore - [clanker semaphore list](https://docs.clankership.com/cli/semaphore/list.md): List the workspace's semaphores and the leases held now ### team - [clanker team list](https://docs.clankership.com/cli/team/list.md): List open teams and the private teams you are in - [clanker team get](https://docs.clankership.com/cli/team/get.md): Show a team and its members - [clanker team create](https://docs.clankership.com/cli/team/create.md): Create a team. - [clanker team update](https://docs.clankership.com/cli/team/update.md): Change a team's name, key or visibility. - [clanker team join](https://docs.clankership.com/cli/team/join.md): Join an open team - [clanker team add-member](https://docs.clankership.com/cli/team/add-member.md): Add a workspace member, by email or user ID - [clanker team remove-member](https://docs.clankership.com/cli/team/remove-member.md): Remove a member, by email or user ID. - [clanker team archive](https://docs.clankership.com/cli/team/archive.md): Archive a team. - [clanker team restore](https://docs.clankership.com/cli/team/restore.md): Restore an archived team - [clanker team delete](https://docs.clankership.com/cli/team/delete.md): Delete a team that has no tickets ### project - [clanker project list](https://docs.clankership.com/cli/project/list.md): List projects in priority order - [clanker project get](https://docs.clankership.com/cli/project/get.md): Show a project with its milestones and document - [clanker project create](https://docs.clankership.com/cli/project/create.md): Create a project for one or more teams - [clanker project update](https://docs.clankership.com/cli/project/update.md): Change a project. - [clanker project reorder](https://docs.clankership.com/cli/project/reorder.md): Move a project in priority order - [clanker project archive](https://docs.clankership.com/cli/project/archive.md): Archive a project. - [clanker project restore](https://docs.clankership.com/cli/project/restore.md): Restore an archived project ### milestone - [clanker milestone create](https://docs.clankership.com/cli/milestone/create.md): Add the next milestone, such as M3 - [clanker milestone update](https://docs.clankership.com/cli/milestone/update.md): Change a milestone, such as M2 - [clanker milestone delete](https://docs.clankership.com/cli/milestone/delete.md): Delete a milestone. ### ticket - [clanker ticket send](https://docs.clankership.com/cli/ticket/send.md): Send a ticket to a clanker with an ask - [clanker ticket comment](https://docs.clankership.com/cli/ticket/comment.md): Comment on a ticket; @Claude reaches your own Claude - [clanker ticket comments](https://docs.clankership.com/cli/ticket/comments.md): List a ticket's comments - [clanker ticket messages](https://docs.clankership.com/cli/ticket/messages.md): List the messages sent to clankers about a ticket, newest first - [clanker ticket checklist add](https://docs.clankership.com/cli/ticket/checklist/add.md): Add items, in order, to the ticket's checklist for its current status, or for --status. - [clanker ticket checklist check](https://docs.clankership.com/cli/ticket/checklist/check.md): Check an item, recording you as who did it - [clanker ticket checklist uncheck](https://docs.clankership.com/cli/ticket/checklist/uncheck.md): Clear a checked item, back to not started - [clanker ticket checklist start](https://docs.clankership.com/cli/ticket/checklist/start.md): Mark an item in progress, recording you as who started it; a checked item is cleared - [clanker ticket checklist stop](https://docs.clankership.com/cli/ticket/checklist/stop.md): Take an item in progress back to not started - [clanker ticket checklist rename](https://docs.clankership.com/cli/ticket/checklist/rename.md): Rename an item - [clanker ticket checklist retag](https://docs.clankership.com/cli/ticket/checklist/retag.md): Change who does an item: human or clanker - [clanker ticket checklist reorder](https://docs.clankership.com/cli/ticket/checklist/reorder.md): Move an item within its checklist - [clanker ticket checklist remove](https://docs.clankership.com/cli/ticket/checklist/remove.md): Remove an item - [clanker ticket doc show](https://docs.clankership.com/cli/ticket/doc/show.md): Show one of a ticket's documents, by name or slug, with its revision. - [clanker ticket doc write](https://docs.clankership.com/cli/ticket/doc/write.md): Write a document whole, from --file or stdin, as its next revision. - [clanker ticket doc edit](https://docs.clankership.com/cli/ticket/doc/edit.md): Replace exact passages of a document as its next revision, all or none. - [clanker ticket doc history](https://docs.clankership.com/cli/ticket/doc/history.md): List a document's revisions, newest first - [clanker ticket ask](https://docs.clankership.com/cli/ticket/ask.md): Ask a question on a ticket; it shows Needs human until someone answers. - [clanker ticket answer](https://docs.clankership.com/cli/ticket/answer.md): Answer a ticket's open question. - [clanker ticket branch link](https://docs.clankership.com/cli/ticket/branch/link.md): Link a ticket to a branch, by default the current one. - [clanker ticket branch unlink](https://docs.clankership.com/cli/ticket/branch/unlink.md): Unlink a branch from a ticket, by default the current one - [clanker ticket pr link](https://docs.clankership.com/cli/ticket/pr/link.md): Link a pull request, by its link such as https://github.com/acme/web/pull/142 or as acme/web#142 - [clanker ticket pr unlink](https://docs.clankership.com/cli/ticket/pr/unlink.md): Unlink a pull request, by its link or as owner/name#number - [clanker ticket list](https://docs.clankership.com/cli/ticket/list.md): List tickets, without their documents and checklists - [clanker ticket get](https://docs.clankership.com/cli/ticket/get.md): Show a ticket with its checklists, branches, pull requests and the list of its documents, by its ID such as WEB-31. - [clanker ticket create](https://docs.clankership.com/cli/ticket/create.md): Create a ticket. - [clanker ticket update](https://docs.clankership.com/cli/ticket/update.md): Change a ticket. - [clanker ticket reorder](https://docs.clankership.com/cli/ticket/reorder.md): Move a ticket in the order every view ordered by hand follows - [clanker ticket move](https://docs.clankership.com/cli/ticket/move.md): Move a ticket to another team. ### view - [clanker view list](https://docs.clankership.com/cli/view/list.md): List a team's, a project's or your own views - [clanker view show](https://docs.clankership.com/cli/view/show.md): Show a view, by slug, with its tickets - [clanker view create](https://docs.clankership.com/cli/view/create.md): Save a view - [clanker view update](https://docs.clankership.com/cli/view/update.md): Change a view; --filters replace the saved ones - [clanker view reorder](https://docs.clankership.com/cli/view/reorder.md): Move a view's tab before or after another - [clanker view delete](https://docs.clankership.com/cli/view/delete.md): Delete a view that is not the default ### status - [clanker status list](https://docs.clankership.com/cli/status/list.md): List a team's statuses, or the workspace's template that new teams copy - [clanker status create](https://docs.clankership.com/cli/status/create.md): Add a status to a team, or to the workspace template without --team - [clanker status update](https://docs.clankership.com/cli/status/update.md): Rename a status, by its ID, or make it the default for new tickets - [clanker status reorder](https://docs.clankership.com/cli/status/reorder.md): Move a status within its category, by ID - [clanker status delete](https://docs.clankership.com/cli/status/delete.md): Delete a status, by ID. - [clanker status checklist add](https://docs.clankership.com/cli/status/checklist/add.md): Add an item to the end of a status's template, by the status's ID - [clanker status checklist rename](https://docs.clankership.com/cli/status/checklist/rename.md): Rename a template item, by its ID or title - [clanker status checklist retag](https://docs.clankership.com/cli/status/checklist/retag.md): Change who does a template item: human or clanker. - [clanker status checklist reorder](https://docs.clankership.com/cli/status/checklist/reorder.md): Move a template item - [clanker status checklist remove](https://docs.clankership.com/cli/status/checklist/remove.md): Delete a template item. - [clanker status instructions show](https://docs.clankership.com/cli/status/instructions/show.md): Show a status's instructions and checklist template, by its ID, or its name with --team - [clanker status instructions set](https://docs.clankership.com/cli/status/instructions/set.md): Change a status's instructions. - [clanker status instructions reset](https://docs.clankership.com/cli/status/instructions/reset.md): Put a status's instructions back to Clanker Ship's for its stage ### tag - [clanker tag list](https://docs.clankership.com/cli/tag/list.md): List workspace tags and team tags, or the tags one team's tickets can use - [clanker tag create](https://docs.clankership.com/cli/tag/create.md): Create a workspace tag, or a team tag with --team - [clanker tag update](https://docs.clankership.com/cli/tag/update.md): Rename or recolor a tag, by its ID - [clanker tag delete](https://docs.clankership.com/cli/tag/delete.md): Delete a tag, by its ID. ### instructions - [clanker instructions show](https://docs.clankership.com/cli/instructions/show.md): Show the instructions a team's clankers follow, or the workspace's without --team - [clanker instructions set](https://docs.clankership.com/cli/instructions/set.md): Set a team's or, without --team, the workspace's instructions. - [clanker instructions reset](https://docs.clankership.com/cli/instructions/reset.md): Remove a team's or the workspace's own instructions, so they follow what they inherit ### clankers - [clanker clankers list](https://docs.clankership.com/cli/clankers/list.md): List the workspace's clankers with their computers, or yours with --mine - [clanker clankers mine](https://docs.clankership.com/cli/clankers/mine.md): List your clankers with whether each is live and the open tickets it works on - [clanker clankers register](https://docs.clankership.com/cli/clankers/register.md): Register this computer as your clanker for a client, as the plugin does at sign-in - [clanker clankers revoke](https://docs.clankership.com/cli/clankers/revoke.md): Revoke one of your clankers, by ID. - [clanker clankers settings](https://docs.clankership.com/cli/clankers/settings.md): Show one of your clankers' settings, by ID, changing the ones given: its default team for new tickets and whether it wakes idle Codex threads ### inbox - [clanker inbox list](https://docs.clankership.com/cli/inbox/list.md): List this clanker's open messages, oldest first, or every message with --all - [clanker inbox show](https://docs.clankership.com/cli/inbox/show.md): Show one of this clanker's messages: its ticket, ask, note, sender and reply - [clanker inbox complete](https://docs.clankership.com/cli/inbox/complete.md): Mark a message done; its sender is told ### hook - [clanker hook](https://docs.clankership.com/cli/hook.md): Run a plugin hook: session-start, prompt, tool, stop. ### channel - [clanker channel](https://docs.clankership.com/cli/channel.md): Hand new messages to an idle Codex thread with codex queue ### session - [clanker session show](https://docs.clankership.com/cli/session/show.md): Show a session's view: its ticket and where the ticket came from, its stage, checklist progress, next Clanker item and Human items, its name and ticket line, and your other open tickets, the ones that need you first - [clanker session ticket](https://docs.clankership.com/cli/session/ticket.md): Pick the ticket a session works on. - [clanker session changes](https://docs.clankership.com/cli/session/changes.md): List what changed on a session's ticket since its turn started, with the turn line; the line is null when nothing changed - [clanker session connect](https://docs.clankership.com/cli/session/connect.md): Hold a session's connection to Clanker Ship until stopped, printing one JSON line for each new session view, each message routed to the session and each change of connection. ### pin - [clanker pin list](https://docs.clankership.com/cli/pin/list.md): List your pins in their order - [clanker pin add](https://docs.clankership.com/cli/pin/add.md): Pin a ticket, project, product, environment, team by its key, such as: clanker pin add ticket WEB-31 - [clanker pin remove](https://docs.clankership.com/cli/pin/remove.md): Unpin it - [clanker pin move](https://docs.clankership.com/cli/pin/move.md): Move a pin right before or after another ### vault - [clanker vault pull](https://docs.clankership.com/cli/vault/pull.md): Print one product's values for one environment as JSON, to pipe into a file or process - [clanker vault secret add](https://docs.clankership.com/cli/vault/secret/add.md): Define a secret's name on a product, with no value yet - [clanker vault secret rename](https://docs.clankership.com/cli/vault/secret/rename.md): Rename a secret - [clanker vault secret get](https://docs.clankership.com/cli/vault/secret/get.md): Show a secret with each environment's version, and its non-production values - [clanker vault secret delete](https://docs.clankership.com/cli/vault/secret/delete.md): Delete a secret with every environment's values and versions - [clanker vault secret set](https://docs.clankership.com/cli/vault/secret/set.md): Set a secret's value, read from stdin, in each product and environment given, creating the name where it is missing - [clanker vault secret generate](https://docs.clankership.com/cli/vault/secret/generate.md): Generate a value on the server for each selected environment - [clanker vault secret clear](https://docs.clankership.com/cli/vault/secret/clear.md): Clear a secret's value in one environment - [clanker vault secret ls](https://docs.clankership.com/cli/vault/secret/ls.md): List a product's secrets with each environment's version and whether it is set - [clanker vault secret history](https://docs.clankership.com/cli/vault/secret/history.md): List a secret's versions in one environment, newest first - [clanker vault secret restore](https://docs.clankership.com/cli/vault/secret/restore.md): Restore an earlier version as the newest one - [clanker vault key list](https://docs.clankership.com/cli/vault/key/list.md): List the workspace's vault keys, without their tokens - [clanker vault key create](https://docs.clankership.com/cli/vault/key/create.md): Create a vault key for some products and production environments; its token prints only this once - [clanker vault key update](https://docs.clankership.com/cli/vault/key/update.md): Replace a vault key's name, products and environments; its token stays the same - [clanker vault key get](https://docs.clankership.com/cli/vault/key/get.md): Show one vault key, without its token - [clanker vault key revoke](https://docs.clankership.com/cli/vault/key/revoke.md): Revoke a vault key; deployments pulling with it get 401 ### test-run - [clanker test-run list](https://docs.clankership.com/cli/test-run/list.md): List published runs, newest first, 50 at a time - [clanker test-run get](https://docs.clankership.com/cli/test-run/get.md): Show a run with its shards, retries, tests and every attempt ### workspace - [clanker workspace list](https://docs.clankership.com/cli/workspace/list.md): List the workspaces you belong to, with your role in each - [clanker workspace get](https://docs.clankership.com/cli/workspace/get.md): Show the workspace: its name, slug, icon, allowed domains and your role - [clanker workspace create](https://docs.clankership.com/cli/workspace/create.md): Create a workspace with you as its owner - [clanker workspace update](https://docs.clankership.com/cli/workspace/update.md): Change the workspace's name, slug, allowed email domains or icon. ### member - [clanker member list](https://docs.clankership.com/cli/member/list.md): List the workspace's active members with their roles and teams - [clanker member update](https://docs.clankership.com/cli/member/update.md): Change a member's role, by email or user ID. - [clanker member remove](https://docs.clankership.com/cli/member/remove.md): Remove a member from the workspace and its teams, by email or user ID ### invite - [clanker invite list](https://docs.clankership.com/cli/invite/list.md): List the workspace's open invites - [clanker invite create](https://docs.clankership.com/cli/invite/create.md): Invite people by email; each gets a link. - [clanker invite update](https://docs.clankership.com/cli/invite/update.md): Change the role an open invite grants, by its ID - [clanker invite resend](https://docs.clankership.com/cli/invite/resend.md): Send an open invite's email again, by its ID - [clanker invite revoke](https://docs.clankership.com/cli/invite/revoke.md): Revoke an open invite, by its ID, so its link stops working - [clanker invite accept](https://docs.clankership.com/cli/invite/accept.md): Join a workspace with the token from an invite link ### profile - [clanker profile update](https://docs.clankership.com/cli/profile/update.md): Change your name or photo; every workspace shows them ### preferences - [clanker preferences get](https://docs.clankership.com/cli/preferences/get.md): Show your email preferences - [clanker preferences set](https://docs.clankership.com/cli/preferences/set.md): Turn product update emails or workspace activity emails on or off ### onboarding - [clanker onboarding get](https://docs.clankership.com/cli/onboarding/get.md): Show the onboarding steps you finished and whether onboarding is over - [clanker onboarding complete](https://docs.clankership.com/cli/onboarding/complete.md): Mark a step done: install-plugin, sign-in, create-ticket, invite-team - [clanker onboarding skip](https://docs.clankership.com/cli/onboarding/skip.md): End onboarding early, as Skip does on the website ### api-key - [clanker api-key list](https://docs.clankership.com/cli/api-key/list.md): List your API keys, without their tokens - [clanker api-key create](https://docs.clankership.com/cli/api-key/create.md): Create an API key that acts as you; its token prints only this once - [clanker api-key revoke](https://docs.clankership.com/cli/api-key/revoke.md): Revoke one of your API keys, by ID ### account-key - [clanker account-key list](https://docs.clankership.com/cli/account-key/list.md): List the workspace's account API keys, without their tokens - [clanker account-key create](https://docs.clankership.com/cli/account-key/create.md): Create an account API key with a role; its token prints only this once - [clanker account-key update](https://docs.clankership.com/cli/account-key/update.md): Rename an account API key or change its role, by ID - [clanker account-key revoke](https://docs.clankership.com/cli/account-key/revoke.md): Revoke an account API key, by ID ### notification - [clanker notification list](https://docs.clankership.com/cli/notification/list.md): List your 100 newest notifications, newest first, read and unread - [clanker notification read](https://docs.clankership.com/cli/notification/read.md): Mark every unread notification read ### event - [clanker event list](https://docs.clankership.com/cli/event/list.md): List the 50 latest events you can see, newest first, or one ticket's activity