SIYUAN-29 - trckr

← SIYUAN-29

feature

Created: 2026-02-02 • Updated: 2026-02-03

Relationships Loading...

## Overview
Add extended export capabilities using undocumented SiYuan APIs.

## New Commands

```bash
# Export entire notebook as markdown zip
siyuan export notebook NOTEBOOK_ID
siyuan export notebook NOTEBOOK_ID --output ./backup.zip

# Export document as HTML
siyuan export html DOC_ID
siyuan export html DOC_ID --output ./doc.html

# Export document as Word
siyuan export docx DOC_ID
siyuan export docx DOC_ID --output ./doc.docx

# Export notebook as OPML (outline)
siyuan export opml NOTEBOOK_ID
siyuan export opml NOTEBOOK_ID --output ./outline.opml
```

## API Endpoints
- `/api/export/exportNotebookMd` - Export notebook as MD zip (params: notebook)
  - Returns: {name, zip (base64)}
- `/api/export/exportHTML` - Export as HTML (params: id, pdf, savePath)
  - Returns: {content, id, name}
- `/api/export/exportDocx` - Export as Word (params: id, savePath)
- `/api/export/exportOPML` - Export as OPML (params: notebook)

## Implementation
1. Add 4 client methods to SiyuanClient
2. Add handler functions for each export type
3. Extend existing `export` CLI group with: notebook, html, docx, opml
4. Handle binary output (base64 decode for zip files)
5. Create `tests/test_export_extended.py`
6. Create `tests/integration/test_export_extended_live.py`
7. Update README

## Output Handling
- For notebook/opml: Decode base64 zip and save to file
- For html: Save content directly
- For docx: Handle binary file properly
- Default output filename based on document/notebook name
- `--output` flag to override output path

## Output Format (text, no --output)
```
Exported notebook "My Notes" to my-notes.zip (2.3 MB)
Contains: 45 documents, 120 assets
```

## QA Verification

### Pass Criteria
1. `siyuan export notebook NOTEBOOK_ID` creates valid zip file
2. `siyuan export html DOC_ID` creates valid HTML file
3. `siyuan export docx DOC_ID` creates valid Word file
4. `siyuan export opml NOTEBOOK_ID` creates valid OPML file
5. `--output` flag works correctly
6. All tests pass

### Fail Criteria
- Exported files are corrupted
- Binary handling fails
- Output path not respected
- Test failures

Pull Requests (comma-separated URLs)

Attachments

Comments (3)

qa-agent · 2026-02-03

## QA Verification Complete ✅ **Result**: PASSED All acceptance criteria met: - All 4 export commands implemented and working - 393/393 tests passing (100% pass rate) - 36 new unit tests added - 12 integration tests created - Pandoc warnings properly documented - Binary/base64 handling correct - --output flag works correctly - Error handling robust - Help text clear and comprehensive See detailed verification report at /tmp/qa-SIYUAN-29.md **Code Quality**: Excellent - Proper separation of concerns - Comprehensive test coverage - Clear documentation - Follows project conventions **No issues or concerns identified. Ready for production.**

agent · 2026-02-03

## Implementation Complete ### Changes Made **Client Methods (siyuan.py ~line 632)**: - `export_notebook_md(notebook_id)` - Export notebook as markdown zip (base64 encoded) - `export_html(doc_id, pdf, save_path)` - Export document as HTML - `export_docx(doc_id, save_path)` - Export document as Word (requires Pandoc) - `export_opml(notebook_id)` - Export notebook as OPML (requires Pandoc) **Handler Functions (siyuan.py ~line 1677)**: - `_format_file_size()` - Utility for human-readable file sizes - `handle_export_notebook_md()` - Decodes base64 zip, writes to file - `handle_export_html()` - Writes HTML content to file - `handle_export_docx()` - Handles API response with Pandoc warnings - `handle_export_opml()` - Decodes base64 zip, writes to file **CLI Commands (siyuan.py ~line 3378)**: - `export notebook NOTEBOOK_ID [--output PATH]` - `export html DOC_ID [--output PATH]` - `export docx DOC_ID [--output PATH]` - `export opml NOTEBOOK_ID [--output PATH]` ### Verification - All 393 unit tests pass - Created 36 new tests in test_export_extended.py - Created integration tests in test_export_extended_live.py - Help text includes Pandoc warnings for docx/opml commands ### Notes - docx and opml commands require Pandoc, which is not available in Docker deployments - Help text and error messages clearly warn about the Pandoc requirement - Base64 decoding for notebook and opml exports works correctly - Output files are written with correct encoding (UTF-8 for HTML, binary for zips)

triage-agent · 2026-02-03

## Feature Triage Complete **Status:** PARTIALLY IMPLEMENTED **Summary:** Extended export commands would add 4 new export types to the existing `export` group. The SiYuan API endpoints are confirmed via source code analysis. **Key Finding:** 2 of 4 requested exports (docx, opml) require Pandoc, which is not available in Docker deployments per CLAUDE.md. These should be implemented with clear warnings. **Confirmed API Endpoints:** - `/api/export/exportNotebookMd` - No Pandoc needed - `/api/export/exportHTML` - No Pandoc needed - `/api/export/exportDocx` - **Requires Pandoc** - `/api/export/exportOPML` - **Requires Pandoc** **Implementation Location:** - Client methods: siyuan.py ~line 632 - Handler functions: siyuan.py ~line 1614 - CLI commands: siyuan.py ~line 3158 **Complexity:** Medium - requires binary/base64 handling for zip exports See attached triage report for full details.