CherryTree

Reporting

Beginnerlow risk

CherryTree is a hierarchical note-taking application featuring rich text, syntax highlighting, and customizable node structures, widely used for organizing and documenting penetration testing findings.

Installation

sudo apt install cherrytree

Basic Syntax

cherrytree

Quick Facts

Full Name

CherryTree Hierarchical Note-Taking

License

GPL v3

Author

Giuseppe Penone

Written In

Python, C++

Platforms

Windows, Linux, macOS

Category

Note Taking / Documentation

First Release

2009

Storage

SQLite (.ctb) or XML (.ctd)

Tool Overview

CherryTree is a hierarchical note-taking application designed for organizing complex information in a tree structure. It is widely used by penetration testers, security researchers, and developers to document findings, store code snippets, and manage project notes.

Created by Giuseppe Penone, CherryTree supports rich text editing, syntax highlighting for dozens of programming languages, embedded images, and table creation. Its node-based hierarchy allows logical organization of information across projects and topics.

CherryTree stores notebooks in SQLite or XML format and supports export to HTML, PDF, and plaintext. Its combination of hierarchical organization, code support, and portability makes it ideal for security professionals managing engagement notes.

Common Commands

cherrytreeLaunch the CherryTree GUI with an empty document

cherrytree notes.ctbOpen an existing SQLite-format (.ctb) document

cherrytree --helpShow usage and the list of command-line options

cherrytree -VPrint the CherryTree version and exit

cherrytree -N notes.ctbOpen the document in a new top-level window

cherrytree notes.ctb -n "Executive Summary"Open and jump straight to the node named Executive Summary

cherrytree notes.ctb -a "screenshot1"Open and scroll to a named anchor inside the tree

cherrytree notes.ctb -p /path/to/report.pdfExport the whole tree to a PDF file and exit

cherrytree notes.ctb -p /path/to/report.pdf -wExport to PDF, overwriting an existing target file

cherrytree notes.ctb -x /path/to/html_dirExport the document to a directory of HTML files

cherrytree notes.ctb -x /path/to/html_dir -sExport to a single self-contained HTML file

cherrytree notes.ctb -t /path/to/txt_dirExport the document to plain-text files

cherrytree notes.ctb -t /path/to/txt_dir -sExport the whole tree to a single plain-text file

cherrytree secure.ctx -P <PASS>Open a password-protected encrypted SQLite (.ctx) document

cherrytree secure.ctz -P <PASS>Open a password-protected encrypted XML (.ctz) document

Step-by-Step Guide

1Open the application interface
2Build out a folder structure that mirrors your testing methodology
3Paste in command outputs, discoveries, and visual evidence
4Format important text and code snippets for readability
5Generate a polished HTML or PDF document for your client delivery

Warnings

Ensure your notebook files are stored on encrypted volumes
Create frequent backups to prevent data loss during long engagements
Redact sensitive client information before sharing the final export

Use Cases

Penetration Test Documentation

Organize findings by target, vulnerability, and severity with a hierarchical note structure.

Code Snippet Library

Store and organize code snippets with syntax highlighting for quick reference.

Research Notes

Maintain structured research notes with nested topics and cross-references.

Incident Response Logs

Document incident response timelines, evidence, and actions in an organized hierarchy.

Project Documentation

Create comprehensive project documentation with embedded images and formatted text.

Key Features

Hierarchical Nodes: Organize notes in an unlimited tree structure with drag-and-drop reordering.
Syntax Highlighting: Code blocks with highlighting for Python, Bash, SQL, JavaScript, and dozens more.
Rich Text Editing: Bold, italic, underline, strikethrough, lists, tables, and embedded images.
SQLite Backend: Fast full-text search and efficient storage with the SQLite (.ctb) format.
Export Formats: Export to HTML, PDF, Markdown, plaintext, and CherryTree XML format.
Password Protection: Encrypt notebooks with a master password for secure storage.

Related Tools

Autopsy

Forensics

Digital forensics platform for analyzing disk images and extracting evidence.

Volatility

Forensics

Memory forensics framework for analyzing RAM dumps.

Nmap

Information Gathering

Network scanning and discovery tool for reconnaissance.

Frequently Asked Questions

What is CherryTree used for?

CherryTree is a hierarchical note-taking application used to organize and document penetration testing findings, research notes, and project documentation. It supports rich text, syntax highlighting, and export to multiple formats.

What storage backends does CherryTree support?

CherryTree supports SQLite (.ctb) and XML (.ctd) storage backends. SQLite is recommended for performance and search capabilities, while XML provides better version control compatibility.

Can CherryTree export to PDF?

Yes, CherryTree can export individual nodes or entire hierarchies to HTML, PDF, plaintext, and Markdown formats. The export preserves formatting, code highlighting, and embedded images.

Is CherryTree available on Linux?

Yes, CherryTree is cross-platform and available on Windows, Linux, and macOS. It is included in Kali Linux and can be installed via apt on most distributions.

Output Explanation

Presents an organized, visually structured digital notebook capable of holding formatted text, embedded images, and syntax-highlighted code blocks, which can be exported entirely.

Ethical Usage Notice

This tool is designed for authorized security testing, educational purposes, and legitimate network administration only. Unauthorized access to computer systems is illegal.