kickoff command — Glaurung

use it for

kickoff indexes functions, names, types, strings, cross-references, and other facts in SQLite. Supply --db or the command uses a temporary project.

Run glaurung kickoff --help on your installed version before putting the command in a script. Glaurung is still pre-1.0.

input: One binary and, for persistent work, a path ending in .glaurung.
output: A SQLite project containing functions, names, types, strings, xrefs, stack slots, and an evidence log.
mode: writes state. Creates or updates the project named by --db.

command shape

syntax

short form

$ glaurung kickoff PATH --db PROJECT

The installed parser is authoritative: glaurung kickoff --help

run it

examples

Create the project used below

Most project commands on this site assume this file and fixture.

run

from the engine checkout

$ glaurung kickoff samples/binaries/platforms/linux/amd64/export/native/clang/debug/hello-c-clang-debug --db hello.glaurung

output

captured result captured 2026-08-31, shortened

# Kickoff analysis — hello-c-clang-debug

- format: **ELF**, arch: **x86_64**, size: **17680** bytes
- entry: **0x1060**

## Functions
- discovered: **16** (with blocks: 16, named: 10)
- callgraph edges: **12**

## Type system
- stdlib prototypes loaded: **114**
- stack slots discovered: **66**

captured 2026-08-31, shortened.

Read the result: The summary names what entered the project. Reopen hello.glaurung with find, view, xrefs, the REPL, or export.

Triage a system binary without keeping it

Omit --db for a disposable run. Use this only when you do not plan to annotate or reopen the result.

run

from the engine checkout

$ glaurung kickoff /bin/ls --max-functions 200

output

captured result captured on the Ubuntu development host, 2026-08-31

# Kickoff analysis — ls

- format: **ELF**, arch: **x86_64**, size: **11352352** bytes
- entry: **0x107fe0**

## Functions
- discovered: **1** (with blocks: 1, named: 0)
- callgraph edges: **0**

## Type system
- stdlib prototypes loaded: **114**
- stack slots discovered: **0**

_completed in 717 ms_

captured on the Ubuntu development host, 2026-08-31.

Read the result: This host's /bin/ls is a large packaged executable with little recoverable naming in the disposable pass. Results vary with the distribution build; use a project when you need to retain and improve them.

used above

important options

--db PROJECT: Keep the analysis in this project instead of a temporary database.
--session NAME: Store facts under a named project session.
--max-functions N: Cap function discovery.
--json: Print the run summary as JSON.

These are the flags used by the examples. Run glaurung kickoff --help for the complete parser help.

before you rely on it

checks

keep working

related commands

← all 40 commands