Contents

• Module 0: Setup
  • Option A: Download a precompiled binary
    • macOS note
  • Option B: Build from source
  • Local setup
    • Try it
  • Troubleshooting
  • Sublime Text syntax highlighting
• Module 0.1: Running Slug
  • Lesson 0.1: Shell scripts
  • Lesson 0.2: CLI usage
  • Lesson 0.3: REPL

Module 0: Setup

Lets get Slug installed and ready to run. Pick one path below.

Option A: Download a precompiled binary

1. Download the latest release from the Slug releases page.
2. Extract the archive and locate the slug binary.
3. Add it to your PATH and set SLUG_HOME (see Local setup below).

macOS note

If you are on macOS, remove quarantine and apply an ad-hoc signature:

xattr -d com.apple.quarantine ./bin/slug
codesign -s - --deep --force ./bin/slug

What these do:

• xattr -d com.apple.quarantine ./bin/slug removes the download quarantine so the binary can run.
• codesign -s - --deep --force ./bin/slug adds an ad-hoc signature so Gatekeeper is satisfied.

Option B: Build from source

If you have Go installed:

git clone https://github.com/babyman/slug-lang.git
cd slug-lang
make build

Local setup

Once you have a slug binary, export SLUG_HOME and add the binary to your PATH:

export SLUG_HOME=[[path to slug home directory]]
export PATH="$SLUG_HOME/bin:$PATH"

SLUG_HOME is where Slug looks for libraries.

Try it

Open a new terminal, run slug --version, and confirm it prints a version.

Troubleshooting

If something is not working, check these first:

• slug: command not found: make sure PATH includes $SLUG_HOME/bin.
• SLUG_HOME not set: export it and open a new terminal.
• macOS “cannot be opened” or “not signed”: re-run the xattr and codesign commands above.
• Imports failing: confirm SLUG_HOME/lib exists and your --root is correct.

Sublime Text syntax highlighting

If you use Sublime Text, install Slug Syntax Highlighting by placing the package in your Packages/User directory.

Module 0.1: Running Slug

This is your quick-start cheat sheet for running programs.

Lesson 0.1: Shell scripts

You can run Slug files as scripts if slug is on your PATH:

#!/usr/bin/env slug
println("Hello Slug!")

Lesson 0.2: CLI usage

slug --root [path to module root] script[.slug] [args...]

• --root sets the module root for imports.
• script can be a file path or a module name.
• extra tokens become program arguments.

Lesson 0.3: REPL

Stay tuned for this feature.