asm README

The project's README from github.com/stubbi/asm. As one markdown file: README.md.

asm

A home for assembly.

Asm is a package registry and command-line tool for assembly projects. Create a project, use packages, and share releases with their source and verification results.

Website · Quick start · Status · Why Asm · Security model

A new era for software

Programming languages made software practical for people to write and maintain. AI opens up a different approach: generate implementations for the machine, and judge them by the experience they deliver.

The priorities are familiar: software that works, responds quickly, and protects its users. As code becomes cheaper to produce, the cost of running it matters more. Memory, compute, and energy use affect both the experience and the cost of delivering it.

Assembly gives direct control over instructions, memory layout, and CPU features. AI could make that control practical for a much wider range of software. Each implementation still needs a way to reach the people and projects that can use it.

Asm brings assembly into a shared package ecosystem: named packages, explicit machine targets, repeatable builds, and evidence tied to each release. The goal is to make efficient, dependable software practical to distribute and reuse.

More on the technical reasoning.

Quick start

Asm 0.6.0 supports Linux x86-64, Linux ARM64, and Apple Silicon with macOS 15 or later.

Install the command

Install GitHub CLI 2.93.0 or later before running the installer.

System Required tools
Linux GitHub CLI at /usr/bin/gh, curl, and GNU Coreutils in /usr/bin.
Apple Silicon macOS GitHub CLI at /opt/homebrew/bin/gh; other tools are supplied by macOS.
curl -qfsS -m120 https://asm.build/install.sh | sh

Apply the PATH command shown by the installer. Then check the version:

asm version

On Apple Silicon, the output is asm 0.6.0 (aarch64-macos).

Set PATH for this terminal
export PATH="$HOME/.local/bin:$PATH"

Add this command to your shell configuration to keep the setting.

Installer source · Installation requirements · macOS filesystem and signing requirements

Run your first project

Install GNU Binutils on Linux, or Xcode Command Line Tools on macOS with xcode-select --install. On Debian or Ubuntu, the binutils package supplies the assembler and linker.

Run these commands from the directory that will contain your new project:

asm doctor &&
asm new hello &&
cd hello &&
asm run &&
asm test

The program prints:

Hello from asm!

The project contains asm.toml, src/main.s, and tests/main.s. Assembly source is text; asm build assembles and links it into the executable build/app. asm run also runs that executable. asm test builds and runs tests/main.s; a zero exit code passes the test.

Update Asm

For an installation made with the installer:

asm self update

For an installation managed by another package manager, use that manager to update Asm.

Projects and packages

Describe a project

asm.toml names the project, its source file, and its target:

[package]
name = "hello"
version = "0.1.0"

[build]
source = "src/main.s"
target = "x86_64-linux"

asm new sets the target for your machine. Linux ARM64 uses aarch64-linux; Apple Silicon macOS uses aarch64-macos.

Asm 0.6.0 also accepts one project with several [target.<id>] implementations. Each target has its own source, test, and optional native-library fields. The hello and math projects keep these inputs under targets/<id>/. asm build --target riscv64-linux builds a separate Linux artifact. asm test --target riscv64-linux --no-run builds its test without executing it. Target-specific dependency selections share one v2 lock. See the multi-target project contract for tools, commands, and platform limits.

Find a package

asm search hello
asm info stubbi/hello
asm versions stubbi/hello
asm fetch stubbi/[email protected] --target x86_64-linux --kind source

This downloads the Linux x86-64 source archive and checks its size and SHA-256 digest. Use asm --help for command options.

Use a source dependency

This example requires Linux x86-64 and gzip at /usr/bin/gzip. From a project directory:

asm add stubbi/[email protected] --target x86_64-linux
asm lock

Include the library in your source:

.include "stubbi/math/0.6.0/x86_64-linux/targets/x86_64-linux/src/min.s"

The complete example calls asm_u64_min and explains its calling convention.

Commit asm.lock with your project. asm sync restores the recorded dependencies. asm build --locked requires the lock file and checks dependencies before assembly.

Install a program

On Linux x86-64 or ARM64:

asm install stubbi/[email protected]

This installs the matching executable at $HOME/.local/bin/hello. Use --output PATH to choose another destination. The destination must be a new file. Asm records both default and custom destinations in its local inventory. One package identity has at most one managed installation.

Inspect and manage recorded programs:

asm installed
asm upgrade stubbi/hello
asm uninstall stubbi/hello

upgrade selects the highest available host version from the recorded registry. Use owner/name@version to select an exact version. update and remove continue to manage project source dependencies.

Published 0.4.0 binaries do not include these management commands. Updating Asm does not adopt earlier installations; programs without an inventory record remain unmanaged. See the installed-program contract for file checks, recovery, and limits.

Status

Asm is an early alpha.

Area Available today
Native CLI Linux x86-64, Linux ARM64, and Apple Silicon macOS 15+.
Projects Create, inspect, build, run, test, and clean; select native or standalone Linux implementations.
Packages Search, inspect versions, download source, install executables, list installations, upgrade, and uninstall.
Dependencies Exact direct source dependencies, with target-specific selections in a shared lock file.
Registry Package search, target filters, release records, and verification results.
Publication Source archives and release records submitted through reviewed pull requests.
Artifact checks Metadata, size, SHA-256, archive structure, and executable format.
CLI updates Manual updates with signed release provenance.

Asm 0.6.0 adds named target implementations, standalone Linux cross builds, and target-specific dependency locks. The release notes describe the commands, artifact scope, and limits.

Projects select the native host by default. Explicit standalone Linux builds produce separate artifacts without executing them. Cross-target native-library linking remains unsupported. Packages can provide separate artifacts for other targets, including RISC-V Linux.

Transitive dependencies, self-service publication, account recovery, isolated public build workers, and hosted formal verification are planned. The roadmap tracks that work.

Publish from source

A package release records its source repository, exact Git commit, target, and artifact digests. asm publish checks the release files and prepares a local submission record. Publication proceeds through a pull request to the registry.

Follow the publishing guide for the commands and submission process.

Build with an AI

The Asm development skill guides requirements, target selection, package reuse, tests, and bounded performance work. The MCP setup guide connects AI clients to read-only discovery, planning, and measurement-comparison tools. The AI uses its authorized workspace tools to build and execute software.

Hosted registry and MCP deployment remain under qualification. The hosted registry contract records the implementation scope and remaining recovery, security, and runtime gates.

Security evidence

Package records distinguish artifact checks, build provenance, formal proofs, and agent reviews. Each result applies to a particular check and artifact. Missing results appear as missing.

The security model explains the checks, trust boundaries, and planned verification services.

Build from source

Install Git, Make, and Python 3.11 or later. Linux also requires GNU Binutils, curl, GNU Coreutils, and gzip. Apple Silicon macOS requires Xcode Command Line Tools.

git clone https://github.com/stubbi/asm.git &&
cd asm &&
make &&
make install PREFIX="$HOME/.local" &&
export PATH="$HOME/.local/bin:$PATH" &&
asm version

make selects the native implementation for your machine. The root asm.toml describes the Linux x86-64 reference build. The ARM64 notes cover cross-assembly; the macOS guide covers Apple Silicon builds.

Contribute

Start with CONTRIBUTING.md and AGENTS.md. The repository layout explains the source, licenses, experiments, and retained measurements. Follow the design guide, writing guide, and code of conduct.

The CLI uses assembly for project and package logic, with system tools for assembly, linking, transport, and cryptographic checks. Python handles registry operations, release automation, and the separate MCP protocol adapter; JavaScript supports the website. The hosted registry runtime foundation uses assembly with mature protocol and database libraries. The bundled-verifier migration uses Go for the Sigstore and TUF adapter.

On Linux, run make check from the repository root. On macOS, run make test. The contribution guide lists test prerequisites, including cross-toolchains. Include the reason for your change and its validation in the pull request. Report defects through GitHub Issues.

License

Asm uses AGPL-3.0-or-later. Starter code and reference examples use MIT. Packages retain the license declared for each version. See the license scope, or run asm license.

asm (stubbi/asm)

Searching Database…

326 ·GitHub
What is this?Asm is a package registry and command-line tool for assembly projects. You create a project, use shared packages, and publish releases with their source and verification results.
Is this a new programming language?No. Assembly stays the language. Asm adds a shared package ecosystem on top, with named packages, explicit machine targets, and repeatable builds.
How do I get it running?Install GitHub CLI 2.93.0 or later, run the installer, apply the PATH command it shows, and then check the version it reports.
What do I need installed first?On Linux you need GitHub CLI, curl, GNU Coreutils, and GNU Binutils for the assembler and linker. On Apple Silicon macOS you need GitHub CLI at /opt/homebrew/bin/gh and Xcode Command Line Tools.
What is the catch?It is an early alpha. Transitive dependencies, self-service publication, account recovery, and hosted formal verification are still planned, and cross-target native-library linking is unsupported.
Which machines does it run on?Linux x86-64, Linux ARM64, and Apple Silicon Macs on macOS 15 or later. Windows is not listed in the README.
Can one project target several machines?Yes. A project can hold several named target implementations, and asm build --target riscv64-linux builds a separate Linux artifact without running it.
Why would anyone write assembly today?The README argues that as code gets cheaper to write, running it costs more. Assembly gives direct control over instructions, memory layout, and CPU features, which AI could make practical for much more software.
How do I create a project and run its tests?Install Binutils or Xcode Command Line Tools, then create a new project. asm build links the executable into build/app, asm run executes it, and asm test runs tests/main.s, where a zero exit code passes.
Can I install a package's program directly?Yes. On Linux x86-64 or ARM64, installing a package puts the matching executable in $HOME/.local/bin, and Asm tracks it in a local inventory. Use --output to pick another path.
What are similar projects?ir, zxdesk, renovate, blog_os, BitKindle, wild, fil-c, solo
Creator
stubbi
Size
28.5 MB
Stars
326
Updated
CommitNov 05
Age
5d
Commits · 90 Days