Eptalights.toml Configuration

The eptalights.toml file defines how Eptalights locates extracted analysis data, identifies projects, and manages local build artifacts. Every build operation requires an eptalights.toml file in the current working directory.

Overview

A minimal configuration file might look like this:

project_id = "your-project-id"
extractor_output_path = "./extractor-output"
code_type = "gcc_gimple"

Only extractor_output_path and code_type are required. All other settings are optional.

Configuration Reference

project_id

The unique identifier of the Eptalights project. This is used to associate builds with your project.

  • Type: string

  • Required: No

  • Example:

    project_id = "my-project-id"
    

extractor_output_path

The path to the output generated by an Eptalights extractor. This directory contains the IR, bytecode, or instruction data that will be processed during build creation.

  • Type: string

  • Required: Yes

  • Example:

    extractor_output_path = "./extractor-output"
    

code_type

Specifies the type of extracted code data that Eptalights should process.

  • Type: string

  • Required: Yes

  • Supported Values:

Supported Values

Value

Description

gcc_gimple

GIMPLE IR generated from C/C++ applications.

php_opcode

PHP bytecode extracted from PHP applications.

jvm_jimple

JVM bytecode and metadata from Java, Kotlin, Scala, Groovy, Clojure, and other JVM languages.

  • Example:

    code_type = "jvm_jimple"
    

storage_backend

Local storage backend used for extracted analysis data. Defaults to SQLite.

  • Type: string

  • Required: No

  • Default: sqlite3

  • Example:

    storage_backend = "sqlite3"
    

local_database_path

Custom path for the local database storing extracted information.

  • Type: string

  • Required: No

  • Example:

    local_database_path = "./database/project.db"
    

output_decompiled_path

Directory for storing decompiled code and related artifacts.

  • Type: string

  • Required: No

  • Default: ./__eptalights_decompiled_code/

  • Example:

    output_decompiled_path = "./decompiled"
    

Example Configurations

C/C++ Project

project_id = "cpp-project-id"
extractor_output_path = "./gcc-output"
code_type = "gcc_gimple"

PHP Project

project_id = "php-project-id"
extractor_output_path = "./php-output"
code_type = "php_opcode"

JVM Project

project_id = "jvm-project-id"
extractor_output_path = "./jvm-output"
code_type = "jvm_jimple"

Full Configuration Example

project_id = "project-id"
extractor_output_path = "./extractor-output"
code_type = "gcc_gimple"
storage_backend = "sqlite3"
local_database_path = "./database/eptalights.db"
output_decompiled_path = "./decompiled"