docmost-cli 0.4.0__py3-none-any.whl

docmost_cli-0.4.0.data/data/share/man/man1/docmost-cli-config.1

@@ -0,0 +1,127 @@
+.\" Manual page for docmost-cli-config(1)
+.\" Source: SPECIFICATION.md section 4.1, src/docmost_cli/cli/config_cmd.py
+.TH DOCMOST\-CLI\-CONFIG 1 "2026\-03\-22" "docmost\-cli 0.4.0" "User Commands"
+.SH NAME
+docmost\-cli\-config \- manage docmost\-cli configuration
+.SH SYNOPSIS
+.B docmost\-cli config init
+.RB [ \-\-profile
+.IR name ]
+.br
+.B docmost\-cli config show
+.br
+.B docmost\-cli config set
+.I key value
+.RB [ \-\-profile
+.IR name ]
+.br
+.B docmost\-cli config test
+.SH DESCRIPTION
+Commands for managing
+.B docmost\-cli
+configuration.
+Configuration is stored in a TOML file at
+.IR ~/.config/docmost\-cli/config.toml
+and supports multiple named profiles for different Docmost instances.
+.PP
+See
+.BR docmost\-cli (1)
+for the full configuration file format, environment variables,
+and priority chain.
+.SH SUBCOMMANDS
+.SS init
+Interactive setup wizard.
+Prompts for the Docmost URL, authentication method (API key or
+email/password), and credentials.
+Writes the result to the configuration file.
+.TP
+.BI \-\-profile " name"
+Profile to configure.
+Default:
+.BR default .
+.PP
+If a profile already exists, its values are shown as defaults in the
+prompts.
+.SS show
+Show current configuration with secrets masked.
+.PP
+Displays a table of all settings for the active profile.
+Sensitive values (API key, password) are partially redacted.
+.SS set
+Set a single configuration value.
+.PP
+.I key
+is the configuration key to set.
+Valid keys:
+.BR url ,
+.BR api_key ,
+.BR email ,
+.BR password .
+.PP
+.I value
+is the value to assign.
+.TP
+.BI \-\-profile " name"
+Profile to update.
+Default:
+.BR default .
+.SS test
+Test connectivity and authentication against the configured Docmost
+instance.
+.PP
+Attempts to connect to the Docmost API and authenticate using the
+current configuration.
+Reports success or a detailed error message.
+.SH EXAMPLES
+Run the interactive setup wizard:
+.PP
+.RS 4
+.EX
+$ docmost\-cli config init
+.EE
+.RE
+.PP
+Set up a staging profile:
+.PP
+.RS 4
+.EX
+$ docmost\-cli config init \-\-profile staging
+.EE
+.RE
+.PP
+Show current configuration:
+.PP
+.RS 4
+.EX
+$ docmost\-cli config show
+.EE
+.RE
+.PP
+Set a single value:
+.PP
+.RS 4
+.EX
+$ docmost\-cli config set url https://docs.example.com
+$ docmost\-cli config set api_key dm_xxxxxxxxxxxxxxxxxxxx \-\-profile staging
+.EE
+.RE
+.PP
+Test the connection:
+.PP
+.RS 4
+.EX
+$ docmost\-cli config test
+.EE
+.RE
+.SH EXIT STATUS
+See
+.BR docmost\-cli (1).
+.SH SEE ALSO
+.BR docmost\-cli (1)
+.SH AUTHORS
+Georg
+.MT georg@mann\-mouse.at
+.ME .
+.SH COPYRIGHT
+Copyright \(co 2026 Georg.
+License AGPLv3+: GNU Affero General Public License version 3 or later.

docmost_cli-0.4.0.data/data/share/man/man1/docmost-cli-page.1

@@ -0,0 +1,412 @@
+.\" Manual page for docmost-cli-page(1)
+.\" Source: SPECIFICATION.md section 4.2, src/docmost_cli/cli/page.py
+.TH DOCMOST\-CLI\-PAGE 1 "2026\-03\-22" "docmost\-cli 0.4.0" "User Commands"
+.SH NAME
+docmost\-cli\-page \- page operations for Docmost wiki
+.SH SYNOPSIS
+.B docmost\-cli page list
+.I space\-slug
+.RB [ \-\-limit
+.IR N ]
+.RB [ \-\-cursor
+.IR cursor ]
+.RB [ \-\-tree ]
+.RB [ \-\-json ]
+.br
+.B docmost\-cli page get
+.I page\-id
+.RB [ \-\-raw ]
+.RB [ \-\-meta ]
+.br
+.B docmost\-cli page create
+.I space\-slug
+.BI \-\-title " title"
+.RB [ \-\-content
+.IR md ]
+.RB [ \-\-file
+.IR path ]
+.RB [ \-\-stdin ]
+.RB [ \-\-parent
+.IR id ]
+.RB [ \-\-icon
+.IR emoji ]
+.br
+.B docmost\-cli page update
+.I page\-id
+.RB [ \-\-title
+.IR title ]
+.RB [ \-\-content
+.IR md ]
+.RB [ \-\-file
+.IR path ]
+.RB [ \-\-stdin ]
+.RB [ \-\-icon
+.IR emoji ]
+.br
+.B docmost\-cli page delete
+.I page\-id
+.br
+.B docmost\-cli page move
+.I page\-id
+.RB [ \-\-parent
+.IR id ]
+.RB [ \-\-space
+.IR slug ]
+.RB [ \-\-position
+.IR N ]
+.br
+.B docmost\-cli page duplicate
+.I page\-id
+.br
+.B docmost\-cli page copy
+.I page\-id
+.BI \-\-space " slug"
+.br
+.B docmost\-cli page children
+.I page\-id
+.RB [ \-\-json ]
+.br
+.B docmost\-cli page history
+.I page\-id
+.RB [ \-\-limit
+.IR N ]
+.RB [ \-\-json ]
+.br
+.B docmost\-cli page export
+.I page\-id
+.RB [ \-\-format
+.BR md | html ]
+.RB [ \-\-output
+.IR path ]
+.br
+.B docmost\-cli page import
+.I space\-slug
+.BI \-\-file " path"
+.RB [ \-\-title
+.IR title ]
+.RB [ \-\-parent
+.IR id ]
+.SH DESCRIPTION
+Commands for managing wiki pages in a Docmost instance.
+Pages contain Markdown content and belong to a space.
+They can be organized hierarchically using parent\-child relationships.
+.PP
+Content is always presented as Markdown.
+The underlying ProseMirror JSON format is converted automatically
+unless
+.B \-\-raw
+is specified.
+.PP
+Page creation uses the server\-side import endpoint for reliable
+Markdown\-to\-ProseMirror conversion.
+.SH SUBCOMMANDS
+.SS list
+List pages in a space.
+.PP
+.I space\-slug
+identifies the space whose pages to list.
+.TP
+.BI \-\-limit " N"
+Maximum number of results to return.
+Default: 50.
+.TP
+.BI \-\-cursor " cursor"
+Pagination cursor from a previous response.
+When omitted, pagination is followed automatically until all pages
+are retrieved (up to
+.BR \-\-limit ).
+.TP
+.B \-\-tree
+Display pages as an indented tree showing the parent\-child hierarchy.
+.TP
+.B \-\-json
+Output as a JSON array instead of a Rich table.
+.SS get
+Get page content as Markdown.
+.PP
+.I page\-id
+is the UUID of the page to retrieve.
+.PP
+By default, only the Markdown content is written to stdout,
+making it suitable for piping or redirection.
+.TP
+.B \-\-raw
+Output the ProseMirror JSON representation instead of Markdown.
+.TP
+.B \-\-meta
+Prepend YAML frontmatter containing page metadata
+(id, title, space, created, updated, creator).
+.SS create
+Create a new page via Markdown import.
+.PP
+.I space\-slug
+identifies the space to create the page in.
+.TP
+.BI \-\-title " title"
+Page title.
+Required.
+.TP
+.BI \-\-content " markdown"
+Inline Markdown content string.
+Mutually exclusive with
+.B \-\-file
+and
+.BR \-\-stdin .
+.TP
+.BI \-\-file " path"
+Read content from a Markdown file.
+Mutually exclusive with
+.B \-\-content
+and
+.BR \-\-stdin .
+.TP
+.B \-\-stdin
+Read content from standard input.
+Mutually exclusive with
+.B \-\-content
+and
+.BR \-\-file .
+.TP
+.BI \-\-parent " id"
+Parent page UUID.
+When set, the new page is nested under this parent.
+.TP
+.BI \-\-icon " emoji"
+Page icon emoji.
+.PP
+Outputs the new page ID to stdout and a confirmation message to stderr.
+.SS update
+Update an existing page's title, icon, and/or content.
+.PP
+.I page\-id
+is the UUID of the page to update.
+At least one of the options below must be provided.
+.TP
+.BI \-\-title " title"
+New page title.
+.TP
+.BI \-\-icon " emoji"
+New page icon emoji.
+.TP
+.BI \-\-content " markdown"
+New Markdown content (inline string).
+Mutually exclusive with
+.B \-\-file
+and
+.BR \-\-stdin .
+.TP
+.BI \-\-file " path"
+Read new content from a file.
+.TP
+.B \-\-stdin
+Read new content from standard input.
+.SS delete
+Delete a page.
+.PP
+.I page\-id
+is the UUID of the page to delete.
+.PP
+Prompts for confirmation unless the global
+.B \-\-yes
+flag is set.
+.SS move
+Move a page to a new location.
+.PP
+.I page\-id
+is the UUID of the page to move.
+At least one of the options below must be provided.
+.TP
+.BI \-\-parent " id"
+New parent page UUID.
+Omit to move the page to the root level.
+.TP
+.BI \-\-space " slug"
+Move the page to a different space.
+.TP
+.BI \-\-position " N"
+Position among siblings (zero\-based index).
+.SS duplicate
+Duplicate a page within the same space.
+.PP
+.I page\-id
+is the UUID of the page to duplicate.
+.PP
+Outputs the new page ID to stdout.
+.SS copy
+Copy a page to a different space.
+.PP
+.I page\-id
+is the UUID of the page to copy.
+.TP
+.BI \-\-space " slug"
+Target space slug.
+Required.
+.PP
+Outputs the new page ID to stdout.
+.SS children
+List child pages of a parent page.
+.PP
+.I page\-id
+is the UUID of the parent page.
+.TP
+.B \-\-json
+Output as a JSON array instead of a Rich table.
+.SS history
+Show page version history.
+.PP
+.I page\-id
+is the UUID of the page.
+.TP
+.BI \-\-limit " N"
+Maximum number of history entries to return.
+.TP
+.B \-\-json
+Output as a JSON array instead of a Rich table.
+.SS export
+Export page content to a file.
+.PP
+.I page\-id
+is the UUID of the page to export.
+.TP
+.BI \-\-format " format"
+Export format:
+.B md
+(Markdown, default) or
+.BR html .
+.TP
+.BI \-\-output " path"
+Write to a file instead of stdout.
+Prompts for confirmation if the file already exists
+(unless
+.B \-\-yes
+is set).
+.SS import
+Import a file as a new page.
+.PP
+.I space\-slug
+identifies the space to import into.
+.TP
+.BI \-\-file " path"
+Markdown or HTML file to import.
+Required.
+.TP
+.BI \-\-title " title"
+Override the page title.
+If omitted, the title is auto\-detected from the filename or
+the first H1 heading in the file.
+.TP
+.BI \-\-parent " id"
+Parent page UUID to nest the imported page under.
+.PP
+Outputs the new page ID to stdout.
+.SH EXAMPLES
+List all pages in a space:
+.PP
+.RS 4
+.EX
+$ docmost\-cli page list engineering
+.EE
+.RE
+.PP
+List pages as a tree:
+.PP
+.RS 4
+.EX
+$ docmost\-cli page list engineering \-\-tree
+.EE
+.RE
+.PP
+Get page content as Markdown and save to file:
+.PP
+.RS 4
+.EX
+$ docmost\-cli page get 019a2a69\-xxxx > page.md
+.EE
+.RE
+.PP
+Get page content with YAML frontmatter:
+.PP
+.RS 4
+.EX
+$ docmost\-cli page get 019a2a69\-xxxx \-\-meta
+.EE
+.RE
+.PP
+Create a page from a file:
+.PP
+.RS 4
+.EX
+$ PAGE_ID=$(docmost\-cli page create eng \-\-title "Deploy Guide" \-\-file deploy.md)
+.EE
+.RE
+.PP
+Create a page from stdin:
+.PP
+.RS 4
+.EX
+$ echo "# Quick Note" | docmost\-cli page create eng \-\-title "Note" \-\-stdin
+.EE
+.RE
+.PP
+Update a page's content from a file:
+.PP
+.RS 4
+.EX
+$ docmost\-cli page update 019a2a69\-xxxx \-\-file updated.md
+.EE
+.RE
+.PP
+Delete a page without confirmation:
+.PP
+.RS 4
+.EX
+$ docmost\-cli \-y page delete 019a2a69\-xxxx
+.EE
+.RE
+.PP
+Move a page to a different space:
+.PP
+.RS 4
+.EX
+$ docmost\-cli page move 019a2a69\-xxxx \-\-space devops
+.EE
+.RE
+.PP
+Export a page as HTML:
+.PP
+.RS 4
+.EX
+$ docmost\-cli page export 019a2a69\-xxxx \-\-format html \-\-output page.html
+.EE
+.RE
+.PP
+Import a Markdown file:
+.PP
+.RS 4
+.EX
+$ docmost\-cli page import eng \-\-file runbook.md \-\-parent 019b3c8f\-yyyy
+.EE
+.RE
+.PP
+Batch\-retrieve page titles as JSON:
+.PP
+.RS 4
+.EX
+$ docmost\-cli page list eng \-\-json | jq \(aq.[].title\(aq
+.EE
+.RE
+.SH EXIT STATUS
+See
+.BR docmost\-cli (1).
+.SH SEE ALSO
+.BR docmost\-cli (1),
+.BR docmost\-cli\-space (1),
+.BR docmost\-cli\-sync (1),
+.BR docmost\-cli\-comment (1)
+.SH AUTHORS
+Georg
+.MT georg@mann\-mouse.at
+.ME .
+.SH COPYRIGHT
+Copyright \(co 2026 Georg.
+License AGPLv3+: GNU Affero General Public License version 3 or later.

docmost_cli-0.4.0.data/data/share/man/man1/docmost-cli-search.1

@@ -0,0 +1,90 @@
+.\" Manual page for docmost-cli-search(1)
+.\" Source: SPECIFICATION.md section 4.5, src/docmost_cli/cli/search.py
+.TH DOCMOST\-CLI\-SEARCH 1 "2026\-03\-22" "docmost\-cli 0.4.0" "User Commands"
+.SH NAME
+docmost\-cli\-search \- full\-text search across a Docmost wiki
+.SH SYNOPSIS
+.B docmost\-cli search query
+.I query
+.RB [ \-\-space
+.IR slug ]
+.RB [ \-\-limit
+.IR N ]
+.RB [ \-\-type
+.BR page | attachment ]
+.RB [ \-\-json ]
+.SH DESCRIPTION
+Full\-text search across all pages and attachments in the Docmost
+workspace.
+Results include a highlighted snippet showing the matching text
+in context.
+.SH SUBCOMMANDS
+.SS query
+Execute a full\-text search.
+.PP
+.I query
+is the search string.
+.TP
+.BI \-\-space " slug"
+Restrict search to a specific space.
+.TP
+.BI \-\-limit " N"
+Maximum number of results.
+Default: 20.
+.TP
+.BI \-\-type " type"
+Filter results by type:
+.B page
+or
+.BR attachment .
+.TP
+.B \-\-json
+Output as a JSON array instead of a Rich table.
+.PP
+Table columns: id, title, highlight.
+.SH EXAMPLES
+Search across the entire wiki:
+.PP
+.RS 4
+.EX
+$ docmost\-cli search query "deployment guide"
+.EE
+.RE
+.PP
+Search within a specific space:
+.PP
+.RS 4
+.EX
+$ docmost\-cli search query "API endpoint" \-\-space eng
+.EE
+.RE
+.PP
+Search for attachments only:
+.PP
+.RS 4
+.EX
+$ docmost\-cli search query "diagram" \-\-type attachment
+.EE
+.RE
+.PP
+Search and output as JSON:
+.PP
+.RS 4
+.EX
+$ docmost\-cli search query "onboarding" \-\-json | jq \(aq.[].title\(aq
+.EE
+.RE
+.SH EXIT STATUS
+See
+.BR docmost\-cli (1).
+.SH SEE ALSO
+.BR docmost\-cli (1),
+.BR docmost\-cli\-page (1),
+.BR docmost\-cli\-attachment (1)
+.SH AUTHORS
+Georg
+.MT georg@mann\-mouse.at
+.ME .
+.SH COPYRIGHT
+Copyright \(co 2026 Georg.
+License AGPLv3+: GNU Affero General Public License version 3 or later.

docmost_cli-0.4.0.data/data/share/man/man1/docmost-cli-space.1

@@ -0,0 +1,111 @@
+.\" Manual page for docmost-cli-space(1)
+.\" Source: SPECIFICATION.md section 4.3, src/docmost_cli/cli/space.py
+.TH DOCMOST\-CLI\-SPACE 1 "2026\-03\-22" "docmost\-cli 0.4.0" "User Commands"
+.SH NAME
+docmost\-cli\-space \- manage Docmost wiki spaces
+.SH SYNOPSIS
+.B docmost\-cli space list
+.RB [ \-\-json ]
+.br
+.B docmost\-cli space create
+.BI \-\-name " name"
+.RB [ \-\-slug
+.IR slug ]
+.RB [ \-\-description
+.IR desc ]
+.br
+.B docmost\-cli space update
+.I space\-slug
+.RB [ \-\-name
+.IR name ]
+.RB [ \-\-description
+.IR desc ]
+.SH DESCRIPTION
+Commands for managing Docmost wiki spaces.
+Spaces are top\-level organizational containers for pages.
+Each space has a unique slug used to identify it in CLI commands.
+.SH SUBCOMMANDS
+.SS list
+List all spaces in the workspace.
+.TP
+.B \-\-json
+Output as a JSON array instead of a Rich table.
+.PP
+Table columns: id, name, slug, description.
+.SS create
+Create a new space.
+.TP
+.BI \-\-name " name"
+Space display name.
+Required.
+.TP
+.BI \-\-slug " slug"
+URL slug for the space.
+Auto\-generated from the name if omitted.
+.TP
+.BI \-\-description " description"
+Space description.
+.PP
+Outputs the new space ID to stdout.
+.SS update
+Update an existing space's name or description.
+.PP
+.I space\-slug
+is a positional argument identifying the space to update.
+At least one of
+.B \-\-name
+or
+.B \-\-description
+must be provided.
+.TP
+.BI \-\-name " name"
+New space name.
+.TP
+.BI \-\-description " description"
+New space description.
+.SH EXAMPLES
+List all spaces:
+.PP
+.RS 4
+.EX
+$ docmost\-cli space list
+.EE
+.RE
+.PP
+List spaces as JSON:
+.PP
+.RS 4
+.EX
+$ docmost\-cli space list \-\-json | jq \(aq.[].slug\(aq
+.EE
+.RE
+.PP
+Create a space with a custom slug:
+.PP
+.RS 4
+.EX
+$ docmost\-cli space create \-\-name "Engineering" \-\-slug eng
+.EE
+.RE
+.PP
+Update a space description:
+.PP
+.RS 4
+.EX
+$ docmost\-cli space update eng \-\-description "Engineering team docs"
+.EE
+.RE
+.SH EXIT STATUS
+See
+.BR docmost\-cli (1).
+.SH SEE ALSO
+.BR docmost\-cli (1),
+.BR docmost\-cli\-page (1),
+.BR docmost\-cli\-sync (1)
+.SH AUTHORS
+Georg
+.MT georg@mann\-mouse.at
+.ME .
+.SH COPYRIGHT
+Copyright \(co 2026 Georg.
+License AGPLv3+: GNU Affero General Public License version 3 or later.