https://github.com/sheepla/pdftree
🌲 A command line tool to extract outline tree from PDF files
https://github.com/sheepla/pdftree
Last synced: 12 months ago
JSON representation
🌲 A command line tool to extract outline tree from PDF files
- Host: GitHub
- URL: https://github.com/sheepla/pdftree
- Owner: sheepla
- License: mit
- Created: 2025-05-05T05:31:43.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-05-05T07:00:06.000Z (about 1 year ago)
- Last Synced: 2025-05-30T00:06:23.013Z (about 1 year ago)
- Language: Rust
- Size: 12.7 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🌲 pdftree
**pdftree** is a command line tool to extract outline tree from PDF file written in Rust.
## Usage
Run the program with the path to the PDF file as the first argument. Note that, of course, if the file has no outline, it will fail.
```
Usage: pdftree [OPTIONS]
Arguments:
Options:
-j, --json Output as JSON
-h, --help Print help
```
For example, `pdftree ./Professional_IPv6.pdf` will result in output like this.
Command line output
```
- 表紙
- 扉裏
- 序文
- 目次
- 更新履歴
- 第I部 インターネットとIPv6の概要
- 第1章 インターネット概要
- 1.1 IPはパケット交換技術
- 1.2 層に分かれるネットワーク
- 1.3 トランスポート層の役割
- 1.4 オープンなプロトコルとRFC
- 第2章 IPv6概論
- 2.1 IPv6アドレス
- 2.2 IPv6アドレスのテキスト表記
- 2.3 IPv6アドレス体系
- 2.4 IPv6におけるユニキャストアドレスの構成要素
- 2.5 IPv6基本プロトコル
- 2.6 ICMPv6の役割
- 2.7 近隣探索プロトコル
- 2.8 IPv6アドレスの自動設定
- 2.9 1つのネットワークインターフェースに複数のIPv6アドレスが設定される
- 2.10 IPv6とIPv4の違い
- 2.11 IPv6対応とは
- 2.12 IPv6インターネットとIPv4インターネットを同時に使う
- 2.13 IPv4とIPv6の共存技術
- 第II部 IPv6プロトコルとその周辺技術
- 第3章 IPv6アドレス体系
- 3.1 IPv6アドレスの種類
- 3.2 IPv6アドレス空間の使い方はIANAが管理している
...
```
Run with the `--json` option to output the outline in JSON. For example, `pdftree --json . /Professional_IPv6.pdf` will produce the following output.
Command line output
```json
[
{
"title": "表紙",
"children": []
},
{
"title": "扉裏",
"children": []
},
{
"title": "序文",
"children": []
},
{
"title": "目次",
"children": [
{
"title": "更新履歴",
"children": []
}
]
},
{
"title": "第I部 インターネットとIPv6の概要",
"children": [
{
"title": "第1章 インターネット概要",
"children": [
{
"title": "1.1 IPはパケット交換技術",
"children": []
},
{
"title": "1.2 層に分かれるネットワーク",
"children": []
},
{
"title": "1.3 トランスポート層の役割",
"children": []
},
{
"title": "1.4 オープンなプロトコルとRFC",
"children": []
}
]
},
{
"title": "第2章 IPv6概論",
"children": [
{
...
```
## Installation
Clone this repository then run `cargo install --path=.` .
## Thanks
- [lopdf](https://github.com/J-F-Liu/lopdf): A Rust library for PDF document manipulation.