outline

KO | EN

gitlite — search

#react #linux #docker #macos #nodejs #awesome #cli #kubernetes #pytorch #security #mcp #openai #ios #open-source

(★ 11)

Reduce a source tree to a structural skeleton suitable for feeding to an LLM.

outline Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# outline

Reduce a source tree to a structural skeleton suitable for feeding to an LLM.
Function and method bodies are dropped; signatures, types, comments and imports
are kept. Unsupported file types pass through unchanged.

Pure Go, no CGo. Parsing is done by [gotreesitter], file selection respects
`.gitignore` via [git-pkgs/gitignore]. Full API docs are on [pkg.go.dev].

```go
import "github.com/git-pkgs/outline"

r, err := outline.Pack(".", outline.Options{Compress: true})
if err != nil {
    return err
}
r.Markdown(os.Stdout)
```

Or per file:

```go
src, _ := os.ReadFile("main.go")
out, ok := outline.Outline(src, "main.go")
```

A Go file like

```go
func SayHello(name string) {
    fmt.Printf("Hello, %s!\n", name)
}
```

becomes

```
func SayHello(name string) {
⋮----
```

with the body elided and gaps marked by `⋮----`.

## API

`Outline(src []byte, filename string) (string, bool)` compresses one file. The
second return is false if the language is not supported.

`Imports(src []byte, filename string) ([]Import, bool)` extracts module imports,
their source-language form, named imports, local aliases, and one-based source
lines. A statement containing both default and named imports returns one value
for each form.

`Refs(src []byte, filename string, receivers []string) ([]Ref, bool)` extracts
direct member accesses on the supplied receiver identifiers. This lets callers
pass the local aliases returned by `Imports` without collecting unrelated
member expressions from the file.

```go
imports, ok := outline.Imports(src, "app.py")
if !ok {
    return
}

refs, _ := outline.Refs(src, "app.py", []string{"flask", "f"})
```

For both functions, false means the language is unsupported or parsing did not
complete, including a parse timeout. A true result with an empty slice means
the language is supported but the file contains no matches. Import and
reference extraction currently cover Go, Ruby, Python, JavaScript,
TypeScript/TSX, Rust, PHP, Elixir, Dart, Swift, Haskell, Perl, Lua,
R, Julia, OCaml, Crystal, Nim, Zig, and D.

`Pack(root string, opts Options) (*Result, error)` walks `root`, applies
`.gitignore` plus a built-in ignore list (vendored deps, build output,
lockfiles), skips binaries and oversized files, and outlines what it can.
`Options` lets you set size and file-count limits, extra ignore patterns,
concurrency, and whether to compress.

`Result` carries `[]File` and a rendered `Tree` string. `Result.Markdown(w)`
and `Result.XML(w)` write the packed document.

`Tree(paths []string) string` renders a box-drawing directory tree from a flat
path list.

`Supported(filename string) bool` reports whether a file's extension maps to a
language with an outlining query.

`SetParseTimeout(d time.Duration)` overrides the per-file parse timeout
(default 1s). Must be called before the first `Outline` or `Pack` call.

## Languages

35 languages have body-stripping queries: Go, Ruby, Python, JavaScript,
TypeScript/TSX, Rust, Java, C, C++, C#, PHP, Kotlin, Swift, Scala, Dart,
Elixir, Erlang, Haskell, Clojure, Perl, Lua, R, Julia, OCaml, F#, Crystal, Nim,
Zig, D, Groovy, HCL/Terraform, Starlark/Bazel, CMake, Bash and Make.
gotreesitter ships ~200 grammars so adding a language means writing one `.scm`
query file. `cmd/outline-compare -dump <lang>` prints the S-expression tree for
stdin and is the easiest way to work out what to capture.

## Performance

On an M1 Pro, outlining runs at ~6 MB/s per core and reaches ~36 MB/s across
all eight via the parser pool. Packing a 600-file repo takes about 34ms; the
Markdown render of that result is ~140µs. Almost all the time is in
gotreesitter's full-parse path; chunk extraction and rendering barely register.

[gotreesitter]: https://github.com/odvcencio/gotreesitter
[git-pkgs/gitignore]: https://github.com/git-pkgs/gitignore
[pkg.go.dev]: https://pkg.go.dev/github.com/git-pkgs/outline

## License

MIT

outline

outline Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

outline

outline Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README