ReferênciaCLI
jiraya knowledge
Referência do comando jiraya knowledge da CLI do Jiraya: subcomandos, uso, flags e exemplos, gerados a partir da ajuda.
Work with the knowledge base
Work with the knowledge base.
The knowledge base is only reachable from a web session or from inside a running task (JIRA-567 / JIRA-723): a `jir_` PAT used outside a task is refused with 403. Run these commands from within a task, or sign in on the web.
Subcomandos
| Comando | Descrição |
|---|---|
jiraya knowledge activity | List recent knowledge base activity (including deletions) |
jiraya knowledge create | Create a knowledge document |
jiraya knowledge delete | Delete a knowledge document |
jiraya knowledge get | Get a knowledge document, or one of its past revisions |
jiraya knowledge history | List the versions of a knowledge document, newest first |
jiraya knowledge list | List knowledge documents |
jiraya knowledge move | Move a knowledge document under a new parent, or to the root |
jiraya knowledge restore | Restore a past revision of a knowledge document as a new revision |
jiraya knowledge search | Search knowledge documents (text, semantic or hybrid) |
jiraya knowledge update | Update a knowledge document |
jiraya knowledge activity
List recent knowledge base activity (including deletions)
Uso
jiraya knowledge activity [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--action string | Only this action: created, updated, renamed, moved, retagged, restored or deleted | |
--actor-type string | Only events by this actor type: member or agent | |
--all | Follow next_cursor until the last page | |
--cursor string | Resume from the next_cursor of a previous page | |
--document string | Only events of this document slug | |
--limit int | Max events per page (1-100) | 50 |
--output string | Output format: table or json | table |
jiraya knowledge create
Create a knowledge document
Uso
jiraya knowledge create [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--allow-external-file | Allow --content-file to read a path outside the current working directory. | |
--content string | Document content (decodes \n, \r, \t, \\; pipe via --content-stdin for multi-line bodies or to preserve literal backslashes) | |
--content-file string | Read document content from a UTF-8 file (preserves multi-line content verbatim). The path must be inside the current working directory unless --allow-external-file is set. | |
--content-stdin | Read document content from stdin (preserves multi-line content verbatim) | |
--output string | Output format: table or json | json |
--parent string | Parent document slug (root document if omitted) | |
--tag stringArray | Tag (repeatable) | |
--template string | Start from a template (decision or investigation); applied only when no content is given | |
--title string | Document title (required) | |
--type string | Document type: memory, decision, investigation or convention |
jiraya knowledge delete
Delete a knowledge document
Uso
jiraya knowledge delete <slug> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--output string | Output format: table or json | json |
jiraya knowledge get
Get a knowledge document, or one of its past revisions
Uso
jiraya knowledge get <slug> [flags]Aliases: show
Flags
| Flag | Descrição | Padrão |
|---|---|---|
--output string | Output format: table or json | json |
--revision int | Show this past revision instead of the current document |
jiraya knowledge history
List the versions of a knowledge document, newest first
Uso
jiraya knowledge history <slug> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--all | Follow next_before until the oldest version | |
--before int | Only versions older than this revision (the next_before of a previous page) | |
--limit int | Max versions per page (1-100) | 50 |
--output string | Output format: table or json | table |
jiraya knowledge list
List knowledge documents
Uso
jiraya knowledge list [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--all | Follow next_cursor until the last page | |
--author-type string | Only documents created by this author type: member or agent | |
--cursor string | Resume the listing from the next_cursor of a previous page | |
--limit int | Max documents per page (1-100) | 50 |
--mode string | Search mode with --query: text, semantic or hybrid (default hybrid) | |
--offset int | Pagination offset (prefer --cursor; ignored when --query is set) | |
--output string | Output format: table or json | table |
--parent string | Only direct children of this document slug | |
--query knowledge search <query> | Search query; same as knowledge search <query> | |
--root | Only root documents (no parent) | |
--tag stringArray | Only documents with this tag (repeatable; all tags must match) | |
--type string | Only documents of this type: memory, decision, investigation or convention |
jiraya knowledge move
Move a knowledge document under a new parent, or to the root
Uso
jiraya knowledge move <slug> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--expected-revision int | Revision you last read; the move fails if the document changed since | |
--output string | Output format: table or json | json |
--parent string | New parent document slug | |
--root | Move the document to the root (clear its parent) |
jiraya knowledge restore
Restore a past revision of a knowledge document as a new revision
Uso
jiraya knowledge restore <slug> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--expected-revision int | Current revision you are replacing (default: the revision read just before restoring) | |
--output string | Output format: table or json | json |
--revision int | Revision to restore (required) |
jiraya knowledge search
Search knowledge documents (text, semantic or hybrid)
Uso
jiraya knowledge search <query> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--author-type string | Only documents created by this author type: member or agent | |
--limit int | Max results (1-100) | 50 |
--mode string | Search mode: text, semantic or hybrid (default hybrid; falls back to text without embeddings) | |
--output string | Output format: table or json | table |
--parent string | Only direct children of this document slug | |
--root | Only root documents (no parent) | |
--tag stringArray | Only documents with this tag (repeatable; all tags must match) | |
--type string | Only documents of this type: memory, decision, investigation or convention |
jiraya knowledge update
Update a knowledge document
Uso
jiraya knowledge update <slug> [flags]Flags
| Flag | Descrição | Padrão |
|---|---|---|
--allow-external-file | Allow --content-file to read a path outside the current working directory. | |
--clear-tags | Remove every tag | |
--content string | New content (decodes \n, \r, \t, \\; pipe via --content-stdin for multi-line bodies or to preserve literal backslashes) | |
--content-file string | Read new content from a UTF-8 file (preserves multi-line content verbatim). The path must be inside the current working directory unless --allow-external-file is set. | |
--content-stdin | Read new content from stdin (preserves multi-line content verbatim) | |
--expected-revision int | Revision you last read; the update fails if the document changed since (default: the revision read just before writing) | |
--output string | Output format: table or json | json |
--tag stringArray | Tag (repeatable) | |
--title string | New title | |
--type string | Document type: memory, decision, investigation or convention |
Atualizado em