ELK

ELK is a complete LC-3 toolchain available both as a CLI program and a Zig library. ELK /ɛlk/ stands for Extended LC-3 Kit, and strives to be the most compatible and featureful implementation available.

Official Codeberg repository | Documentation | Releases | GitHub mirror

Usage

For more detailed documentation, see the ELK Usage Guide.

# Show all options
elk --help

# Assemble and emulate
elk hello.asm

# Assemble and debug
elk hello.asm --debug

# Assemble to object file
elk hello.asm --assemble [--output hello.obj]

# Emulate object file
elk hello.obj --emulate

Quick Installation

For more detailed installation instructions, see the ELK Usage Guide.

1. Download the latest binary release from GitHub releases.
2. Install the downloaded file to your PATH:

install <filename> ~/.local/bin/elk

Learn More

• Why ELK?
• About LC-3
• Setup
  • Installation
  • Editor Integration
• Reference
  • ELK Command-Line Interface
  • ELK Library Features
  • ELK Extensions to LC-3
  • ELK Style Guide

Contributors

Want to contribute? Check out the open issues, or share your own ideas! 😀

Additional thanks to:

• @twhlynch for providing editor integration for Neovim and VSCode.
• @ida5428 for helping with Homebrew distribution.

Usage Examples

Inspecting a running program with the ELK debugger

Some useful diagnostics whilst compiling a faulty assembly program