dianju-ofd-tools

\r

name: dianju-ofd-tools\r
description: An OFD document processing tool that can convert local PDF and OFD files to each other and extract content from OFD files.  \r
version:1.0.0  \r
email:[email protected] \r
```\r
# OFD Tools Skill\r
\r
## Quick Start\r
\r
```\r
npx dianju-ofd-tools --APP_ID=xxx --APP_KEY=xxx --API_URL=http://ip:port/DCS\r
```\r
\r
APP_ID：appid\r
\r
APP_KEY：appkey\r
\r
API_URL：The system API address\r
\r
## Features\r
\r
### 1. PDF to OFD Conversion\r
- **Tool Name:** `pdf_to_ofd`\r
- **Description:** Convert local PDF files to OFD format\r
- **Parameters:**\r
  ```json\r
  {\r
    "filePath": "string" // Absolute path to local PDF file\r
  }\r
  ```\r
- **Returns:** Temporary download link for the generated OFD file\r
\r
### 2. OFD to PDF Conversion\r
- **Tool Name:** `ofd_to_pdf`\r
- **Description:** Convert local OFD files to PDF format\r
- **Parameters:**\r
  ```json\r
  {\r
    "filePath": "string" // Absolute path to local OFD file\r
  }\r
  ```\r
- **Returns:** Temporary download link for the generated PDF file\r
\r
### 3. OFD Content Extraction\r
- **Tool Name:** `get_ofd_content`\r
- **Description:** Extract text content from local OFD files\r
- **Parameters:**\r
  ```json\r
  {\r
    "filePath": "string" // Absolute path to local OFD file\r
  }\r
  ```\r
- **Returns:** JSON array of extracted text content\r
\r
\r
## Usage Examples\r
\r
### Example 1: Convert PDF to OFD\r
```bash\r
ofd-tools pdf_to_ofd --filePath "/path/to/input.pdf"\r
```\r
\r
### Example 2: Convert OFD to PDF\r
```bash\r
ofd-tools ofd_to_pdf --filePath "/path/to/input.ofd"\r
```\r
\r
### Example 3: Extract OFD Content\r
```bash\r
ofd-tools get_ofd_content --filePath "/path/to/input.ofd"\r
```\r
\r
## Notes\r
\r
1. **File Paths:** Ensure the local file path is correct (absolute path recommended for non-current directory files).\r
2. **Temporary Links:** The `ofd_to_pdf` and `pdf_to_ofd` services return temporary download links for converted files; check link validity before use.\r
3. **Link Expiry:** OFD download links may expire after a set time; download the file promptly.\r
4. **File Integrity:** Always verify the integrity of the generated OFD file before sharing or using it.\r
5. **Performance:** Large files may take longer to process; avoid interrupting the conversion process.\r
6. **Logging:** Enable logging with `ENABLE_LOGGING=true` for troubleshooting; logs can be output to files with `LOG_TO_FILE=true`.\r
\r
## Error Handling\r
\r
- **File Not Found:** Ensure the file path is correct and the file exists\r
- **Permission Denied:** Check file permissions and ensure the tool has read access\r
- **Conversion Failed:** Verify the input file is valid and not corrupted\r
- **Network Issues:** Check internet connectivity when using external conversion services\r
\r
## Support\r
\r
For issues or questions, contact support at [email protected].