docmost-cli 0.4.0__py3-none-any.whl

docmost_cli-0.4.0.dist-info/METADATA

@@ -0,0 +1,241 @@
+Metadata-Version: 2.4
+Name: docmost-cli
+Version: 0.4.0
+Summary: CLI tool for managing Docmost wiki instances
+Project-URL: Homepage, https://github.com/glinhard/docmost-cli
+Project-URL: Repository, https://github.com/glinhard/docmost-cli
+Project-URL: Issues, https://github.com/glinhard/docmost-cli/issues
+Project-URL: Changelog, https://github.com/glinhard/docmost-cli/blob/main/CHANGELOG.md
+Author-email: Georg <georg@mann-mouse.at>
+License-Expression: AGPL-3.0-or-later
+License-File: LICENSE
+Keywords: cli,docmost,documentation,wiki
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Documentation
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx<1.0,>=0.27
+Requires-Dist: pydantic-settings<3.0,>=2.0
+Requires-Dist: pydantic<3.0,>=2.0
+Requires-Dist: rich<15.0,>=13.0
+Requires-Dist: tomli-w<2.0,>=1.0
+Requires-Dist: tomli<3.0,>=2.0; python_version < '3.12'
+Requires-Dist: typer<1.0,>=0.12
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest-httpx>=0.30; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# docmost-cli
+
+<!-- Badges placeholder -->
+[![PyPI version](https://img.shields.io/pypi/v/docmost-cli)](https://pypi.org/project/docmost-cli/)
+[![Python](https://img.shields.io/pypi/pyversions/docmost-cli)](https://pypi.org/project/docmost-cli/)
+[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL--3.0-blue.svg)](LICENSE)
+
+**A command-line tool for managing Docmost wiki instances from the terminal.**
+
+---
+
+## Features
+
+- **Page CRUD** -- create, read, update, and delete wiki pages with Markdown content
+- **Space management** -- list, create, and update workspaces
+- **Comments** -- add, edit, and list comments on any page
+- **Full-text search** -- search across pages and attachments
+- **ProseMirror conversion** -- automatic conversion between Docmost's ProseMirror JSON and Markdown
+- **Tree view** -- display page hierarchies as indented trees
+- **Configuration profiles** -- manage multiple Docmost instances with named profiles
+- **Edition-agnostic** -- works with both Docmost Enterprise (API key) and Community (email/password)
+- **Unix-friendly output** -- data to stdout, messages to stderr; every command is pipeable
+
+## Installation
+
+### From PyPI (recommended)
+
+```bash
+pip install docmost-cli
+```
+
+### With pipx (isolated environment)
+
+```bash
+pipx install docmost-cli
+```
+
+### From source
+
+```bash
+git clone https://github.com/glinhard/docmost-cli.git
+cd docmost-cli
+uv pip install -e .
+```
+
+## Quick Start
+
+```bash
+# 1. Set up your configuration (interactive wizard)
+docmost-cli config init
+
+# 2. Test connectivity and authentication
+docmost-cli config test
+
+# 3. List all spaces
+docmost-cli space list
+
+# 4. Get a page as Markdown
+docmost-cli page get <page-id>
+
+# 5. Create a new page from a Markdown file
+docmost-cli page create <space-slug> --title "My Page" --file content.md
+```
+
+## Command Reference
+
+| Command | Description |
+|---|---|
+| `docmost-cli config init` | Interactive configuration setup wizard |
+| `docmost-cli config show` | Show current configuration (secrets masked) |
+| `docmost-cli config set <key> <value>` | Set a configuration value |
+| `docmost-cli config test` | Test connectivity and authentication |
+| `docmost-cli page list <space-slug>` | List pages in a space (`--tree`, `--json`) |
+| `docmost-cli page get <page-id>` | Get page content as Markdown (`--meta`, `--raw`) |
+| `docmost-cli page create <space-slug>` | Create a new page (`--title`, `--file`, `--stdin`) |
+| `docmost-cli page update <page-id>` | Update a page (`--title`, `--content`, `--file`) |
+| `docmost-cli page delete <page-id>` | Delete a page (with confirmation, `--yes` to skip) |
+| `docmost-cli page move <page-id>` | Move a page (`--parent`, `--space`, `--position`) |
+| `docmost-cli page duplicate <page-id>` | Duplicate a page |
+| `docmost-cli page copy <page-id>` | Copy a page to another space (`--space`) |
+| `docmost-cli page children <page-id>` | List child pages (`--json`) |
+| `docmost-cli page history <page-id>` | Show page version history (`--json`) |
+| `docmost-cli page export <page-id>` | Export page (`--format md\|html`, `--output`) |
+| `docmost-cli page import <space-slug>` | Import a Markdown file as a new page |
+| `docmost-cli space list` | List all spaces (`--detail`, `--json`) |
+| `docmost-cli space get <space-slug>` | Get space details |
+| `docmost-cli space create` | Create a new space (`--name`, `--slug`) |
+| `docmost-cli space update <space-slug>` | Update a space (`--name`, `--description`) |
+| `docmost-cli comment list <page-id>` | List comments on a page (`--json`) |
+| `docmost-cli comment create <page-id>` | Add a comment (`--content`) |
+| `docmost-cli comment update <comment-id>` | Edit a comment (`--content`) |
+| `docmost-cli search <query>` | Full-text search (`--space`, `--limit`, `--json`) |
+| `docmost-cli attachment search <query>` | Search attachments (`--space`) |
+| `docmost-cli workspace info` | Show workspace details |
+| `docmost-cli workspace members` | List workspace members (`--json`) |
+| `docmost-cli user me` | Show authenticated user info |
+
+## Configuration
+
+### Config file location
+
+```
+~/.config/docmost-cli/config.toml
+```
+
+Override with `--config /path/to/config.toml` on any command.
+
+### Profiles
+
+The config file supports multiple named profiles for managing different Docmost instances:
+
+```toml
+[default]
+url = "https://docs.example.com"
+api_key = "dm_xxxxxxxxxxxxxxxxxxxx"
+
+[staging]
+url = "https://staging-docs.example.com"
+api_key = "dm_yyyyyyyyyyyyyyyyyyyy"
+```
+
+Switch profiles with `--profile` or `-p`:
+
+```bash
+docmost-cli --profile staging space list
+```
+
+### Environment variables
+
+All configuration values can be overridden via environment variables:
+
+| Variable | Description |
+|---|---|
+| `DOCMOST_URL` | Docmost instance URL |
+| `DOCMOST_API_KEY` | API key (Enterprise edition) |
+| `DOCMOST_EMAIL` | Login email (Community edition) |
+| `DOCMOST_PASSWORD` | Login password (Community edition) |
+| `DOCMOST_PROFILE` | Active profile name |
+
+Environment variables take precedence over config file values.
+
+## Authentication
+
+### Enterprise edition (API key)
+
+Use an API key for authentication. Set it in the config file or via `DOCMOST_API_KEY`:
+
+```bash
+docmost-cli config set api_key "dm_xxxxxxxxxxxxxxxxxxxx"
+```
+
+### Community edition (email/password)
+
+Use email and password for session-based authentication:
+
+```bash
+docmost-cli config set email "user@example.com"
+docmost-cli config set password "secret"
+```
+
+The CLI automatically detects which auth method to use: if `api_key` is present it uses token auth, otherwise it falls back to email/password session auth.
+
+## Tab Completion
+
+Enable shell tab completion for all commands and options:
+
+```bash
+docmost-cli --install-completion
+```
+
+Supports bash, zsh, fish, and PowerShell.
+
+## Development
+
+```bash
+# Clone and install in development mode
+git clone https://github.com/glinhard/docmost-cli.git
+cd docmost-cli
+uv pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run tests with coverage
+pytest --cov=docmost_cli
+
+# Linting and formatting
+ruff check src/ tests/
+ruff format src/ tests/
+
+# Type checking
+mypy src/
+```
+
+## Acknowledgments
+
+This CLI is a third-party tool for [Docmost](https://docmost.com), an open-source collaborative wiki and documentation platform — an alternative to Confluence and Notion. Docmost is created by [@Philipinho](https://github.com/Philipinho) and [contributors](https://github.com/docmost/docmost/graphs/contributors), licensed under [AGPL-3.0](https://github.com/docmost/docmost/blob/main/LICENSE).
+
+## License
+
+AGPL-3.0. See [LICENSE](LICENSE) for details.

docmost_cli-0.4.0.dist-info/RECORD

@@ -0,0 +1,56 @@
+docmost_cli/__init__.py,sha256=e7oAaMunhSGKygdQffkxJuJk6fV_d1pbc14UO1L7_zw,115
+docmost_cli/__main__.py,sha256=wda-6iOudWQWrwRqGebaDfjBlz4z9wcEzAJPky5KJxQ,569
+docmost_cli/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+docmost_cli/api/__init__.py,sha256=K7Mx3WmgxsoI86NQxzrg5HMPGQiNIUdMTBNm1q_W_rs,126
+docmost_cli/api/attachments.py,sha256=L0EW4j7sx2Q5QdjWY8QrOA2NbA-WLWaeG5qSDYMx1Gc,714
+docmost_cli/api/auth.py,sha256=Enc67TzPfFa2gPLMKVWlh5Zyg-zjgpVCgzxd93_wJys,6525
+docmost_cli/api/client.py,sha256=yZBNIN8syzlEowMqZWwraeoLSPwmjmNUQQW1atvLtf8,9831
+docmost_cli/api/comments.py,sha256=t2i8O8pzwSR_sb7GORFZKZMDZ-VnytNZH0yxsH1jIG0,2452
+docmost_cli/api/pages.py,sha256=EKAumvxwqpuvdIlD8YZOhtYS9AIwKTv1JbuHDsBKJmw,15220
+docmost_cli/api/pagination.py,sha256=ZrfmRifEakzPsorKiMYflFw22Q_tgBqL2CyTWrjm02M,2904
+docmost_cli/api/search.py,sha256=QLGEA4V-LeI0A-SohNOigL0-zT8XEeMC_0NEy3Jgkg4,994
+docmost_cli/api/spaces.py,sha256=bECdd1MonSUqG6Cycxzaj0C5aBGZthwV-cebzYJUSAg,3511
+docmost_cli/api/users.py,sha256=NCSLC_hR2861dHwQrnhgBIoshlzzit_O_RuzU5ktbnA,554
+docmost_cli/api/workspace.py,sha256=4RijK84kcyWUEqYgGCpNph5_Q6QGcHnUfBTwnDkz5Gk,1022
+docmost_cli/cli/__init__.py,sha256=S35q33aDXlZ6raNIFnMPpYUrG4N873nYky8l3kD4-8k,52
+docmost_cli/cli/attachment.py,sha256=P-rd1FoiHO5FaPz9aaRhFIiPbaZQfD5RQfxxQZhTbCw,1063
+docmost_cli/cli/comment.py,sha256=DQOzei0qo7IRAcb0wJANfu8C3tW0CaqrzKOQjUvhLq0,2676
+docmost_cli/cli/config_cmd.py,sha256=gaSf22NJuKdPvhD5t09G1ZzHMQ4A_Re_mfQvJ-5tq-8,4608
+docmost_cli/cli/main.py,sha256=UQ4nqmhZ_o6b5oXoWcCnjZRZOpJYxwTZmfQ-EH9mAkQ,3866
+docmost_cli/cli/page.py,sha256=olrJXtP78xat-7vCn2m1uJghNbLR79LV9wXF-TAVpao,13057
+docmost_cli/cli/search.py,sha256=1sVuCTd5_g-fWtkgQ8KkVIXjoNrJTBLZLzmc20dJSdQ,1235
+docmost_cli/cli/space.py,sha256=LD3qlWfIoj7TMqoKRPd4bDkQzOI2QpKdXZ_Nptmja_A,2030
+docmost_cli/cli/sync_cmd.py,sha256=4FDHVbz-NcqWOhMDtowmqksSAaATo8WnzHIsRvzrAio,4462
+docmost_cli/cli/user.py,sha256=9JBGF1exU6keWduyIWh8USg6h02KeTX8u6zyKZj5qYM,648
+docmost_cli/cli/workspace.py,sha256=etbtHqnSCQ3eehFSNh2CYeqfoLrBytFu3pFuh-RvvwY,1299
+docmost_cli/config/__init__.py,sha256=BDPNtI9Y2sVv3r14NAKfrU7agYKhTICCawZ_-PP0caY,486
+docmost_cli/config/settings.py,sha256=kg0skvXGat4HU2Z-oeup2xBzLfQQa550UGKGSSkilhw,601
+docmost_cli/config/store.py,sha256=FwEhNm8CgxqIjR0QSq6R3VRQ6A_MFaV6gl5tRNuqqYU,4729
+docmost_cli/convert/__init__.py,sha256=sWLE_uONPznDXNmLaJ9axri1ybULY064oxZEI2Wos8g,68
+docmost_cli/convert/prosemirror_to_md.py,sha256=ihFyRniuHr9p6LMWenOf1GIGua7Axy2n1JBvG1FjLbI,10695
+docmost_cli/models/__init__.py,sha256=GVv82YIdL2LniOrAJdtnufyVky-8ZYSWxAEbc6VYhU4,75
+docmost_cli/models/common.py,sha256=PQOXYnEAaVCxcrN8pHxYFjc5Mc_8dlzzCHID2Aa3aQw,75
+docmost_cli/output/__init__.py,sha256=-CGzyRNqvDrOY2zK6y7hUGmfdAVkxRLXSDg9vrBECnk,347
+docmost_cli/output/formatter.py,sha256=hybpAtsmEPD4gWSreymiEUichBsJBwa96octIGG_CMU,2429
+docmost_cli/output/tree.py,sha256=JCbf3wnlc7rnNTt0eLm7P1r2auIw2prMX57Rcu_ZVWk,1816
+docmost_cli/sync/__init__.py,sha256=Hsehefeh1sqkv4vsBXnQDBeMfTVXbXek0MUnps9NN3k,1154
+docmost_cli/sync/diff.py,sha256=hPcOMWCVHXE0bMcEqMbY44WjFIM_6PhzOLgJ23SVJTw,5197
+docmost_cli/sync/frontmatter.py,sha256=wmE3G-Y6CxHG7zcp41yKmgo1SQkZiV4kkQpAcWz_PDY,4575
+docmost_cli/sync/manifest.py,sha256=yxDMGYLwOn0bnFWnBaZjGmFisisWaAk0Jv9F2HSHzg8,5736
+docmost_cli/sync/pull.py,sha256=i4sDEQ0rmLS9fF8VYoMYeUX9ud9-ZOj0vA3S29UjKPs,4947
+docmost_cli/sync/push.py,sha256=jcDK5NPfvcButeuo39QkE6p_uqSAUvz07pue3qieOzw,12139
+docmost_cli-0.4.0.data/data/share/man/man1/docmost-cli-attachment.1,sha256=RCBJi58n2La3OkuELWIGkn7Gkwjb2-lL-2ai0ful55I,1261
+docmost_cli-0.4.0.data/data/share/man/man1/docmost-cli-comment.1,sha256=8zg2qg9t3h4LIxaaXo3tESlN6wpsmJ5uIJq1rqQejYQ,1933
+docmost_cli-0.4.0.data/data/share/man/man1/docmost-cli-config.1,sha256=YsQHIt0UuPaACdixon4wl_DZmL-D2ttve8BcRc5wSVc,2577
+docmost_cli-0.4.0.data/data/share/man/man1/docmost-cli-page.1,sha256=Do_8e5u_LsylhWVO23Q_iozSMelm0XHToNXm0B8Nlt8,7768
+docmost_cli-0.4.0.data/data/share/man/man1/docmost-cli-search.1,sha256=SLAz-_jDBmfWz_NG7JTP4MrmiN0Bu0c5VsMF2AzFQ3U,1757
+docmost_cli-0.4.0.data/data/share/man/man1/docmost-cli-space.1,sha256=RNIZBz_-lgtnOuX-OXKlsl72CX7iyS4QerlSUuwPM_c,2189
+docmost_cli-0.4.0.data/data/share/man/man1/docmost-cli-sync.1,sha256=Gf3QjJpQGOK0W7v9MCoAp2efwzxicFYHmCLqPUdBh_8,4384
+docmost_cli-0.4.0.data/data/share/man/man1/docmost-cli-user.1,sha256=4O67BbAzeLjZaGsLBxu17EmTHEUUH1nQYzVzSzUw5i8,1007
+docmost_cli-0.4.0.data/data/share/man/man1/docmost-cli-workspace.1,sha256=67r3f6YimP3yqzJ8hgtvRxK2vUxtOX3XZ4_7Fx8hgm4,1424
+docmost_cli-0.4.0.data/data/share/man/man1/docmost-cli.1,sha256=18Wp_-uuQ74SwgUlLibU1i7996q-4ZgI2KN_yJA3xKA,6890
+docmost_cli-0.4.0.dist-info/METADATA,sha256=ZaMGbkOAKCrasO5QkfWwVQJUNKdWt25kQsvOq_6TfuM,8248
+docmost_cli-0.4.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+docmost_cli-0.4.0.dist-info/entry_points.txt,sha256=_1F-BcaNNqO_Ky9nh_wikRoFACDpcN020tP15kKgaNQ,57
+docmost_cli-0.4.0.dist-info/licenses/LICENSE,sha256=DZak_2itbUtvHzD3E7GNUYSRK6jdOJ-GqncQ2weavLA,34523
+docmost_cli-0.4.0.dist-info/RECORD,,

docmost_cli-0.4.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

docmost_cli-0.4.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+docmost-cli = docmost_cli.cli.main:app