ghost.GET STARTED ↗
GHOST / DOCUMENTATION

Documentation.

Everything currently available in Ghost, from installation to the command reference.

01 / GETTING STARTED

Installation

Ghost currently targets Linux. You need Python 3.10 or newer and Git.

Clone the repository

git clone https://github.com/uatimuu-cmyk/ghost.git
cd ghost

Create a virtual environment

python -m venv .venv
source .venv/bin/activate

For Fish shell, use:

source .venv/bin/activate.fish

Install Ghost

python -m pip install -e .
02 / FIRST RUN

Using Ghost

Run Ghost without arguments to open the home screen:

ghost

For built-in help:

ghost --help
03 / COMMAND REFERENCE

Commands

ghost help

Show the available Ghost commands.

ghost updates

Check available package updates using pacman. This does not install updates and is intended for Arch-based distributions.

ghost disk

Display used space, free space, total capacity and usage percentage for your home and root filesystems.

ghost large

Search your home directory for files of at least 500 MiB. The scan checks up to 12,000 files and displays up to 12 results. It does not delete anything.

ghost vault

Display useful Linux commands for inspecting your system. These commands are shown as text and are not executed automatically.

04 / SAFETY

Read-only by design

The current Ghost tools are designed to inspect your system. They do not install packages, delete files, run maintenance operations or execute commands from the vault.

Always inspect a command before choosing to run it yourself.