asm
The package registry and command-line tool for assembly projects.
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Badge for your README
Markdown
[](/listings/stubbi--asm)HTML
<a href="/listings/stubbi--asm"><img src="/api/listings/stubbi--asm/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
These steps run a script from the network that findsafeskills does not scan.
Asm 0.7.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](https://cli.github.com/) before running the installer. The installer uses it to check the CLI release's signed build provenance.
| 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.7.0 (aarch64-macos)`.
<details> <summary>Set PATH for this terminal</summary>
export PATH="$HOME/.local/bin:$PATH"
Add this command to your shell configuration to keep the setting.
</details>
[Installer source](https://asm.build/install.sh) · [Installation requirements](docs/self-update.md) · [macOS filesystem and signing requirements](docs/macos.md)
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 new hello && cd hello && asm run
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. If a build fails, use `asm doctor` to check the required tools.
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.
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
README.md · README · 358 lines · 1 finding marked
- # asm
- **A home for assembly.**
- Asm is the package registry and command-line tool for assembly projects.
- Create and test projects, inspect packages, and download exact artifacts.
- [Website](https://asm.build) · [Quick start](#quick-start) · [Status](#status) · [Why Asm](docs/why-asm.md) · [Security model](docs/specs/security.md) · [Sponsor Asm](https://asm.build/sponsors)
- Packages declare their targets and connect release records to exact source and artifact digests.
- The [project purpose](docs/why-asm.md) explains our technical assumptions about AI-assisted assembly.
- ## Quick start
- Asm 0.7.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](https://cli.github.com/) before running the installer.
- The installer uses it to check the CLI release's signed build provenance.
- | 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. |
- ```sh
- curl -qfsS -m120 https://asm.build/install.sh | sh
- Note: Pipes a downloaded script directly into a shell (curl | sh / wget | bash)
- Line 28 on GitHub
- ```
- Apply the PATH command shown by the installer.
- Then check the version:
- ```sh
- asm version
- ```
- On Apple Silicon, the output is `asm 0.7.0 (aarch64-macos)`.
- <details>
- <summary>Set PATH for this terminal</summary>
- ```sh
- export PATH="$HOME/.local/bin:$PATH"
- ```
- Add this command to your shell configuration to keep the setting.
- </details>
- [Installer source](https://asm.build/install.sh) · [Installation requirements](docs/self-update.md) · [macOS filesystem and signing requirements](docs/macos.md)
- ### 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:
- ```sh
- asm new hello &&
- cd hello &&
- asm run
- ```
- The program prints:
- ```text
- 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.
- If a build fails, use `asm doctor` to check the required tools.
- ### Update Asm
- For an installation made with the installer:
- ```sh
- 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 and declares its target implementations:
- ```toml
- [package]
- name = "hello"
- version = "0.1.0"
- [target.x86_64-linux]
- source = "targets/x86_64-linux/src/main.s"
- test = "targets/x86_64-linux/tests/main.s"
- [target.aarch64-macos]
- source = "targets/aarch64-macos/src/main.s"
- test = "targets/aarch64-macos/tests/main.s"
- ```
- Each target has its own source, test, and optional native-library fields.
- The [hello](examples/hello/README.md) and [math](examples/math/README.md) projects keep these inputs under `targets/<id>/`.
- Asm selects the host target by default.
- For cross builds, install the tools listed in the [multi-target project contract](docs/multi-target-projects.md).
- From either reference project, `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.
- `asm new` creates a single-target `[build]` manifest for your host.
- This form remains supported.
- ### Find a package
- These examples use the public V1 catalog and retain exact 0.6.0 package versions.
- ```sh
- asm search hello
- asm info stubbi/hello
- asm versions stubbi/hello
- asm fetch stubbi/hello@0.6.0 --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:
- ```sh
- asm add stubbi/math@0.6.0 --target x86_64-linux
- asm lock
- ```
- Include the library in your source:
- ```asm
- .include "stubbi/math/0.6.0/x86_64-linux/targets/x86_64-linux/src/min.s"
- ```
- The [complete example](docs/use-a-package.md) 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
- Program management works on all three CLI hosts.
- A package must provide a matching executable.
- For `hello` 0.6.0, use Linux x86-64 or ARM64:
- ```sh
- asm install stubbi/hello@0.6.0
- ```
- 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:
- ```sh
- 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.
- Updating Asm does not adopt earlier installations; programs without an inventory record remain unmanaged.
- See the [installed-program contract](docs/installed-programs.md) for file checks, recovery, and limits.
- ## Status
- The current published prerelease is [Asm 0.7.0](https://github.com/stubbi/asm/releases/tag/v0.7.0).
- | 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 artifacts, install executables, list installations, upgrade, and uninstall. |
- | Dependencies | V1 exact direct selections; signed V2 ranges, transitive graphs, optional dependencies, and features for one explicit target. |
- | Registry | Package search, target filters, release records, and verification results. |
- | Publication | Local V1 records and scoped V2 publishing to configured registries. Official hosted activation remains gated. |
- | Artifact checks | Metadata, size, SHA-256, archive structure, and executable format. |
- | CLI updates | Manual updates with signed release provenance. |
- Asm 0.7.0 adds signed V2 distribution, native project publishing, complete dependency graphs, and additive features.
- The [release notes](docs/releases/0.7.0.md) 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.
- Self-service enrollment, account recovery, isolated public build workers, and hosted formal verification remain planned.
- The [roadmap](docs/roadmap.md) tracks that work.
- Published Asm 0.7.0 includes [signed V2 distribution](docs/specs/registry-v2.md), publishing from committed projects, and explicit mirror selection.
- The [release workflow](https://github.com/stubbi/asm/actions/runs/42499673815) records qualification from [the release source](https://github.com/stubbi/asm/commit/11f526c2f4264b8c33c4865ff03862857424c184).
- The public catalog retains its V1 compatibility feeds.
- V2 commands use an explicitly configured registry, trusted root, and HTTPS mirrors.
- Official hosted V2 publication is not activated.
- It requires qualified key custody, enrolled owners, deployment identities, and recovery checks.
- Its [hosting guide](docs/hosting.md#operate-signed-v2-distribution) describes the minimal components and build commands.
- Application and package logic remain assembly; maintained libraries provide transport and cryptography.
- Private registry operations and tests use suitable other languages.
- The [signed distribution evidence](docs/registry-v2-evidence.md) records the baseline artifacts and deployment gates.
- The [project and statistics evidence](docs/project-publication-evidence.md) records the subsequent source extension.
- An [explicit V2 website build](docs/hosting.md#build-the-v2-website) connects package pages, native fetch commands, and download observations without another service.
- The [website evidence](docs/v2-website-evidence.md) records its checks and limits.
- The V2 workflow resolves transitive source dependencies and complete graph locks for one explicit target.
- Native `registry resolve` selects versions; `registry sync` restores those exact selections.
- Optional dependencies remain dormant until a feature activates them.
- Use `registry resolve --features NAME[,NAME]` to select root features.
- Use `--no-default-features` to disable the root's implicit default feature.
- Incoming dependency requests combine additively for each selected package.
- New resolutions write `asm-lock-v4`, including the root selection, enabled features, and active edges.
- Feature-free `asm-lock-v3` files remain readable; feature declarations require a new resolution.
- The [dependency workflow](docs/hosting.md#resolve-and-restore-v2-dependencies) states the supported ranges, limits, and local build checks.
- The [dependency evidence](docs/v2-dependency-evidence.md) records target-specific checks and deployment limits.
- Earlier published binaries retain their original bytes and behavior.
- ## Publish a package
- Follow the [project publication instructions](docs/hosting.md#publish-a-project) to submit a committed project to a configured V2 registry.
- The registry operator supplies enrollment and a scoped credential.
- Official hosted V2 publication remains unavailable pending qualification.
- <a id="prepare-a-release-record"></a>
- ### Prepare a local release record
- A package release records its source repository, exact Git commit, target, and artifact digests.
- `asm publish` checks the release files and prepares a local release record.
- It makes no network request and publishes nothing.
- The hosted operator can import accepted catalog snapshots.
- Public publisher authentication and hosted deployment remain unqualified.
- Use the [packaging and compatibility guide](registry/README.md) to prepare artifacts and records.
- The [hosted publication boundary](docs/hosted-registry.md#publication-boundary) states the remaining requirements.
- The [hosting guide](docs/hosting.md) covers conditional storage, byte mirrors, and asynchronous origin observations.
- The [`asm registry publish` command](docs/hosting.md#use-the-native-v2-client) accepts a committed project or prepared V2 manifests and digest-named objects.
- ## Build with an AI
- The [Asm development skill](skills/asm-build/SKILL.md) guides requirements, target selection, package reuse, tests, and bounded performance work.
- The [MCP setup guide](docs/agents.md) 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](docs/hosted-registry.md) 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](docs/specs/security.md) explains the checks, trust boundaries, and planned verification services.
- ## Build from source
- Install Git, Make, Python 3.11 or later, and the Go SDK declared in [verifier/go.mod](verifier/go.mod).
- The Go SDK must be available directly; builds disable automatic toolchain switching and ambient Go workspace configuration.
- Linux also requires GNU Binutils, curl, GNU Coreutils, and gzip.
- Apple Silicon macOS requires Xcode Command Line Tools.
- ```sh
- 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.
- It builds the transport and cryptography adapter, then assembles and links the full native CLI.
- Go supplies no package selection, feature evaluation, project parsing, or installation policy.
- Make also provides test and installation commands.
- Use `make REGISTRY_V2=0` for an explicit V1-only build without the adapter or Go prerequisite.
- This minimal build cannot use `asm registry` commands.
- The root `asm.toml` describes the minimal Linux x86-64 reference build.
- The [CLI source guide](cli/README.md) explains the layout and installation helper.
- The [ARM64 notes](cli/aarch64/README.md) cover cross-assembly; the [macOS guide](docs/macos.md) covers Apple Silicon builds.
- ## Support Asm
- Help fund maintainer time, registry operations, security work, and documentation.
- The [sponsorship page](https://asm.build/sponsors) lists company and individual options, recognition, and terms.
- Sponsorships are arranged by email.
- Confirm availability and payment details before you pay.
- ## Contribute
- Start with [CONTRIBUTING.md](CONTRIBUTING.md) and [AGENTS.md](AGENTS.md).
- The [repository layout](CONTRIBUTING.md#repository-layout) explains the source, licenses, experiments, and retained measurements.
- Follow the [design guide](design.md), [writing guide](docs/writing.md), and [code of conduct](CODE_OF_CONDUCT.md).
- 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 native V2 client embeds the Go transport and cryptography adapter.
- The separate [self-update trust migration](docs/trusted-distribution.md) remains gated on production key provisioning and recovery qualification.
- On Linux, run `make check` from the repository root.
- On macOS, run `make test`.
- The [contribution guide](CONTRIBUTING.md) lists test prerequisites, including cross-toolchains.
- Include the reason for your change and its validation in the pull request.
- Report defects through [GitHub Issues](https://github.com/stubbi/asm/issues).
- ## License
- Copyright (c) 2026 ASM contributors.
- Unless a file has a separate notice, Asm uses [AGPL-3.0-or-later](LICENSE).
- You can use version 3 or a later version published by the Free Software Foundation.
- Asm is provided without warranty.
- | Material | License |
- | --- | --- |
- | CLI, registry tools, website, tests, and project documentation | AGPL-3.0-or-later |
- | `cli/templates.s`, `cli/aarch64/templates.s`, and their emitted starter text | MIT |
- | Reference packages under `examples/` | Each package's included MIT license |
- | Independently published packages | The license declared by that package version |
- | Earlier published versions | The license included with that version |
- Executables that embed the Go adapter include dependencies under their upstream license terms.
- Each such release provides the matching `.LICENSES.txt` file.
- The adapter's own source uses AGPL-3.0-or-later.
- Starter assembly files contain the complete MIT notice.
- The same notice remains in [examples/hello/LICENSE](examples/hello/LICENSE) and [examples/math/LICENSE](examples/math/LICENSE).
- It covers the identified MIT material and preserves the notice for material originally distributed in Asm 0.1.0.
- Running Asm does not assign its license to a separate program.
- Copied or linked package code has its own license conditions.
- Contributions use the license that applies to the affected material.
- Keep required copyright and permission notices.
- Asm 0.1.0 was published under MIT.
- Asm 0.2.0 introduced AGPL-3.0-or-later for the platform.
- Earlier releases retain their original bytes and licenses.
- Run `asm license` for the identifier, source location, and warranty notice.
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.