Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/WyattBrashear/507ex-utils2/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through the complete FZX2 workflow: creating a project, declaring dependencies, building a .507ex executable, executing it locally, and optionally uploading it to a CAR server for distribution. By the end you will have a working executable that anyone with FZX2 installed can run with a single command.
Make sure FZX2 is installed before continuing. See the installation guide if you haven’t set it up yet.
1

Create your project directory

Create a directory for your project. FZX2 will package everything inside it.
mkdir my_app
Your finished project structure will look like this:
my_app/
├── runfile
├── dependfile
└── main.py
2

Add a runfile

The runfile tells FZX2 how to start your project when someone runs the executable. It must exist — fzx2 build will raise an error without it.Create my_app/runfile with the shell command that starts your application:
python3 main.py
This is a plain-text file containing a single shell command. FZX2 executes this command verbatim inside a temporary directory when fzx2 exec is called.
3

Add a dependfile (optional)

The dependfile declares pip packages that your project requires. FZX2 reads this at execution time and installs any missing packages before running the executable, so the person running the file does not need to set up a virtual environment manually.Create my_app/dependfile:
!PIP|python3 -m pip install
!PLATFORM *
together
The format has three parts:
  • !PIP|<install command> — the command FZX2 uses to install packages
  • !PLATFORM <platform> — target platform constraint; * means all platforms
  • One package name per line after that
If your project has no external dependencies, you can skip this file entirely.
4

Add your main script

Add the Python script that your runfile calls. Create my_app/main.py:
import together
print("hi")
Replace this with your actual application code. The file just needs to exist at the path referenced in your runfile.
5

Build the executable

Run fzx2 build with the path to your project directory:
fzx2 build my_app
FZX2 will:
  1. Verify that my_app/runfile exists
  2. Zip the directory contents
  3. Compute a BLAKE2s hash of the archive
  4. Prepend the 507ex 2.0 metadata header
  5. Write my_app.507ex to the current directory
On success you will see:
Successfully built my_app.507ex
The output file is always named after the input directory with a .507ex extension and is written to the current working directory.
6

Execute the executable

Run the .507ex file locally:
fzx2 exec my_app.507ex
FZX2 will verify the content hash, install any declared dependencies from the dependfile, and then execute the command from the runfile. For this example, you should see:
hi
Hash verification happens before execution. If the file has been modified since it was built, fzx2 exec will refuse to run it.
7

Upload to a CAR server (optional)

To share your executable, push it to a running CAR server. Start the server first if you’re hosting it yourself:
fzx2 start_server .
Then upload the executable from another terminal:
fzx2 upload my_app.507ex
The server returns a URL and a one-time secret code:
{
  "status": "success",
  "secret_code": "482917",
  "url": "http://localhost:5000/pull/my_app"
}
Share both the URL and the secret code with whoever needs to run the executable. Keep the secret code private — it is required to download the file.
The secret code is shown only once at upload time and is not stored in plaintext on the server. If you lose it, the file cannot be retrieved and must be re-uploaded.
8

Execute from a CAR URL (optional)

Anyone with FZX2 installed, the URL, and the secret code can run the executable directly without downloading it first:
fzx2 exec http://localhost:5000/pull/my_app
FZX2 will prompt for the secret code, download the file, verify its hash, install dependencies, and execute it — all in one step.

What’s next

CLI reference

See all flags and options for every FZX2 command.

Format overview

Understand the 507ex 2.0 header structure in detail.

Dependfile reference

Full syntax for declaring dependencies and platform constraints.

CAR server

Run and configure your own CAR distribution server.

Build docs developers (and LLMs) love