Skip to main content

Module help

Module help 

Source
Expand description

Long help text.

--help is documentation an agent reads instead of loading a file, which makes it a token cost paid per command rather than per session. So: examples first, then only what changes a decision — what the command costs, what it refuses to do, and what the output will not tell you. Nothing here restates a flag list clap already prints below it.

-h keeps the one-line summary. The two are different audiences: a person scanning, and a caller deciding.

Constants§

ATTACHMENT_DELETE
ATTACHMENT_DOWNLOAD
ATTACHMENT_LIST
ATTACHMENT_SHOW
ATTACHMENT_UPLOAD
AUTH_LIST
AUTH_LOGOUT
AUTH_STATUS
AUTH_USE
BOARD_GET
BOARD_LIST
BOARD_SPRINTS
BULK_STATUS
CHEATSHEET
CHECK_ADD
CHECK_DELETE
CHECK_TICK
CHECK_UNTICK
COMMENT_DELETE
COMMENT_EDIT
COMPLETIONS
COMPONENT_LIST
DICT_LIST
ENTITY_CREATE
ENTITY_DELETE
ENTITY_UPDATE
FIELD_GET
FIELD_LIST
GOAL_GET
GOAL_LIST
ISSUE_CHANGELOG
ISSUE_CHECK
ISSUE_CHECKLIST
ISSUE_COMMENT
ISSUE_COMMENTS
ISSUE_COUNT
ISSUE_CREATE
ISSUE_FIND
ISSUE_GET
ISSUE_LINK
ISSUE_LINKS
ISSUE_MOVE
ISSUE_REMOTELINKS
ISSUE_TIMER
ISSUE_TIMERS
ISSUE_TRANSITION
ISSUE_UPDATE
ISSUE_WORKLOG
ISSUE_WORKLOGS
LINK_ADD
LINK_DELETE
LINK_TYPES
PORTFOLIO_CONTENTS
PORTFOLIO_GET
PORTFOLIO_LIST
PORTFOLIO_PLACE
PROJECT_GET
PROJECT_LIST
PROJECT_PLACE
QUEUE_ACCESS
QUEUE_AUTOMATION
QUEUE_CREATE
QUEUE_FIELDS
QUEUE_GET
QUEUE_LIST
QUEUE_LOCAL_FIELDS
QUEUE_TAGS
QUEUE_VERSIONS
ROOT
SPRINT_GET
SPRINT_LIST
TEMPLATE_LIST
TIMER_CANCEL
TIMER_START
TIMER_STOP
USER_FIND
USER_GET
USER_LIST
WORKLOG_ADD
WORKLOG_DELETE
WORKLOG_EDIT
WORKLOG_FIND

Functions§

md
Render a help block for whoever is reading it.