Command Line Interface (CLI)

The CLI of solx is designed to mimic that of solc. There are several main input/output (I/O) modes in the solx interface:

The basic CLI is simpler and suitable for using from the shell. The standard JSON mode is similar to client-server interaction, thus more suitable for using from other applications.

All toolkits using solx must be operating in standard JSON mode and follow its specification. It will make the toolkits more robust and future-proof, as the standard JSON mode is the most versatile and used for the majority of popular projects.

This page focuses on the basic CLI mode. For more information on the standard JSON mode, see this page.

Basic CLI

Basic CLI mode is the simplest way to compile a file with the source code.

To compile a basic Solidity contract, run the simple example from the --bin section.

The rest of this section describes the available CLI options and their usage. You may also check out solx --help for a quick reference.

All examples on this page are executable and verified against the compiler on every change. Unless stated otherwise, they compile this contract, Simple.sol:

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

contract Simple {
    uint256 private field_1;
    uint256 private field_2;
    uint256 private field_3;

    function first() public pure returns (uint64) {
        return 1;
    }

    function second() public pure returns (uint256) {
        return 2;
    }
}

The examples use the following notation:

  • $ precedes the command being run; the lines below it show the command's output.
  • [..] matches any text within a line — used for values that differ between runs or environments, such as timings and hashes.
  • ... on its own line elides a run of output lines.
  • ? failed marks a command that exits with a non-zero code.

All commands on this page run in one shared working directory, so sections that emit files use per-section output directories (./build-evmla/, ./build-ethir/, …) to keep each listing scoped to its own artifacts.

--bin

Emits the full bytecode.

$ solx 'Simple.sol' --bin

======= Simple.sol:Simple =======
Binary:
34601557630000008480630000001a6080396080f35b5f5ffdfe34600b57600336116016575b5f5ffd5b5060016031565b5f3560e01c633df4ddf48114600f57635a8ac02d03600b5760025b60805260206080f3fea2646970667358221220[..]64736f6c637816736f6c783a302e312e373b736f6c633a302e382e33340047

--bin-runtime

Emits the runtime part of the bytecode.

$ solx 'Simple.sol' --bin-runtime

======= Simple.sol:Simple =======
Binary of the runtime part:
34600b57600336116016575b5f5ffd5b5060016031565b5f3560e01c633df4ddf48114600f57635a8ac02d03600b5760025b60805260206080f3fea2646970667358221220[..]64736f6c637816736f6c783a302e312e373b736f6c633a302e382e33340047

--asm

Emits the text assembly produced by LLVM.

$ solx 'Simple.sol' --asm

======= Simple.sol:Simple =======
Deploy LLVM EVM assembly:
	.file	"Simple[..]"
	.text
	.globl	__entry                         ; -- Begin function __entry
__entry:                                ; @__entry
; %bb.0:                                ; %entry
	CALLVALUE
	PUSH4           @.BB0_2
	JUMPI
...

Runtime LLVM EVM assembly:
	.file	"Simple[..]runtime"
	.text
	.globl	__entry                         ; -- Begin function __entry
__entry:                                ; @__entry
; %bb.0:                                ; %entry
	CALLVALUE
	PUSH4           @.BB0_2
	JUMPI
...

--metadata

Emits the contract metadata. The metadata is a JSON object that contains information about the contract, such as its name, source code hash, the list of dependencies, compiler versions, and so on.

The solx metadata format is compatible with the Solidity metadata format. This means that the metadata output can be used with other tools that support Solidity metadata. The metadata that is hashed into the CBOR trailer of the bytecode additionally carries extra solx data inserted into the solc metadata with this JSON object:

{
  "solx": {
    "llvm_options": [],
    "optimizer_settings": {
      "is_debug_logging_enabled": false,
      "is_fallback_to_size_enabled": false,
      "is_verify_each_enabled": false,
      "level_back_end": "Aggressive",
      "level_middle_end": "Aggressive",
      "level_middle_end_size": "Zero"
    },
    // Optional: only set for Solidity and Yul contracts.
    "solc_version": "0.8.34",
    // Mandatory: current version of solx.
    "solx_version": "0.1.7"
  }
}

Usage:

$ solx 'Simple.sol' --metadata

======= Simple.sol:Simple =======
Metadata:
{"compiler":{"version":"0.8.34+commit.[..]"},"language":"Solidity","output":{"abi":[{"inputs":[],"name":"first","outputs":[{"internalType":"uint64","name":"","type":"uint64"}],"stateMutability":"pure","type":"function"},{"inputs":[],"name":"second","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"pure","type":"function"}],"devdoc":{"kind":"dev","methods":{},"version":1},"userdoc":{"kind":"user","methods":{},"version":1}},"settings":{"compilationTarget":{"Simple.sol":"Simple"},"evmVersion":"osaka","libraries":{},"metadata":{"bytecodeHash":"ipfs"},"optimizer":{"enabled":false,"runs":200},"remappings":[]},"sources":{"Simple.sol":{"keccak256":"0x402fe0b38cc9d81e8c9f6d07854cca27fbb307f06d8a129998026907a10c7ca1","license":"MIT","urls":["bzz-raw://04714cab56c1f931e3cc1ddae4c7ff0c8832d0849e23966c6326028f6783d45a","dweb:/ipfs/QmehmUFKCtytG8WcWQ676KvqwURfkVYK89VHZEvSzyLc2Z"]}},"version":1}

--ast-json

Emits the AST of each Solidity file.

$ solx 'Simple.sol' --ast-json

======= Simple.sol =======
JSON AST:
{"absolutePath":"Simple.sol","exportedSymbols":{"Simple":[24]},"id":25,"license":"MIT","nodeType":"SourceUnit","nodes":[[..]],"src":"32:288:0"}

======= Simple.sol:Simple =======

The nodes array — the AST body itself — is abbreviated here; it spans several thousand characters even for this small contract.

Since solx communicates with solc only via standard JSON under the hood, the full JSON AST is emitted instead of the compact one.

--abi

Emits the contract ABI specification.

$ solx 'Simple.sol' --abi

======= Simple.sol:Simple =======
Contract JSON ABI:
[{"inputs":[],"name":"first","outputs":[{"internalType":"uint64","name":"","type":"uint64"}],"stateMutability":"pure","type":"function"},{"inputs":[],"name":"second","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"pure","type":"function"}]

--hashes

Emits the contract function signatures.

$ solx 'Simple.sol' --hashes

======= Simple.sol:Simple =======
Function signatures:
3df4ddf4: first()
5a8ac02d: second()

--storage-layout

Emits the contract storage layout.

$ solx 'Simple.sol' --storage-layout

======= Simple.sol:Simple =======
Contract Storage Layout:
{"storage":[{"astId":3,"contract":"Simple.sol:Simple","label":"field_1","offset":0,"slot":"0","type":"t_uint256"},{"astId":5,"contract":"Simple.sol:Simple","label":"field_2","offset":0,"slot":"1","type":"t_uint256"},{"astId":7,"contract":"Simple.sol:Simple","label":"field_3","offset":0,"slot":"2","type":"t_uint256"}],"types":{"t_uint256":{"encoding":"inplace","label":"uint256","numberOfBytes":"32"}}}

--transient-storage-layout

Emits the contract transient storage layout.

$ solx 'Simple.sol' --transient-storage-layout

======= Simple.sol:Simple =======
Contract Transient Storage Layout:
{"storage":[],"types":null}

--userdoc

Emits the contract user documentation.

$ solx 'Simple.sol' --userdoc

======= Simple.sol:Simple =======
User Documentation:
{"kind":"user","methods":{},"version":1}

--devdoc

Emits the contract developer documentation.

$ solx 'Simple.sol' --devdoc

======= Simple.sol:Simple =======
Developer Documentation:
{"kind":"dev","methods":{},"version":1}

--asm-solc-json

Emits the solc EVM assembly parsed from solc's JSON output.

$ solx 'Simple.sol' --asm-solc-json

======= Simple.sol:Simple =======
EVM assembly:
000     PUSH                80
001     MEMORYGUARD
002     PUSH                40
003     MSTORE
...

This is the solc EVM assembly output that is translated to LLVM IR by solx. For solx's own EVM assembly output emitted by LLVM, use the --asm option instead.

--ir (or --ir-optimized)

Emits the solc Yul IR.

solx does not use the Yul optimizer anymore, so the Yul IR is always unoptimized, and it is not possible to emit solc-optimized Yul IR with solx.

$ solx 'Simple.sol' --ir

======= Simple.sol:Simple =======
IR:

/// @use-src 0:"Simple.sol"
object "Simple_24" {
    code {
...
    }
    /// @use-src 0:"Simple.sol"
    object "Simple_24_deployed" {
        code {
...
        }

        data ".metadata" hex"a2646970667358221220[..]64736f6c63430008220033"
    }

}



--debug-info

Emits the ELF-wrapped DWARF debug info of the deploy code.

$ solx 'Simple.sol' --debug-info

======= Simple.sol:Simple =======
Debug info:
7f454c46010201ff[..]

Only the ELF magic is shown: the DWARF payload embeds the absolute build directory, so its bytes differ between machines and are not reproducible documentation material.

--debug-info-runtime

Emits the ELF-wrapped DWARF debug info of the runtime code.

$ solx 'Simple.sol' --debug-info-runtime

======= Simple.sol:Simple =======
Debug info of the runtime part:
7f454c46010201ff[..]

The payload is abbreviated for the same reason as in --debug-info.

--evmla

Emits EVM legacy assembly (intermediate representation from solc).

When used with --output-dir, writes .evmla files to the output directory. Without --output-dir, outputs to stdout.

Usage with --output-dir:

$ solx 'Simple.sol' --evmla --output-dir './build-evmla/'
Compiler run successful. Artifact(s) can be found in directory "./build-evmla/".

$ ls './build-evmla/'
Simple_sol_Simple.evmla
Simple_sol_Simple_runtime.evmla

Usage with stdout:

$ solx 'Simple.sol' --evmla --bin

======= Simple.sol:Simple =======
Binary:
...
Deploy EVM legacy assembly:
000     PUSH                80
...

--ethir

Emits Ethereal IR (intermediate representation between EVM assembly and LLVM IR).

When used with --output-dir, writes .ethir files to the output directory. Without --output-dir, outputs to stdout.

Usage with --output-dir:

$ solx 'Simple.sol' --ethir --output-dir './build-ethir/'
Compiler run successful. Artifact(s) can be found in directory "./build-ethir/".

$ ls './build-ethir/'
Simple_sol_Simple.ethir
Simple_sol_Simple_runtime.ethir

Usage with stdout:

$ solx 'Simple.sol' --ethir --bin

======= Simple.sol:Simple =======
Binary:
...
Deploy Ethereal IR:
function __entry {
    stack_usage: 4
...

--emit-llvm-ir

Emits LLVM IR (both unoptimized and optimized).

When used with --output-dir, writes .ll files to the output directory. Without --output-dir, outputs to stdout.

Usage with --output-dir:

$ solx 'Simple.sol' --emit-llvm-ir --output-dir './build-llvm-ir/'
Compiler run successful. Artifact(s) can be found in directory "./build-llvm-ir/".

$ ls './build-llvm-ir/'
Simple_sol_Simple.optimized.ll
Simple_sol_Simple.unoptimized.ll
Simple_sol_Simple_runtime.optimized.ll
Simple_sol_Simple_runtime.unoptimized.ll

Usage with stdout:

$ solx 'Simple.sol' --emit-llvm-ir --bin --via-ir

======= Simple.sol:Simple =======
Binary:
...
Deploy LLVM IR (unoptimized):
; ModuleID = 'Simple.sol:Simple'
...
Deploy LLVM IR:
; ModuleID = 'Simple.sol:Simple'
...

--benchmarks

Emits benchmarks of the solx LLVM-based pipeline and its underlying call to solc.

$ solx 'Simple.sol' --benchmarks
Benchmarks:
solc_Solidity_Standard_JSON: [..]ms
solx_Solidity_IR_Analysis: [..]ms
solx_Compilation: [..]ms

======= Simple.sol:Simple =======
Benchmarks:
    Simple.sol:Simple:deploy/EVMAssemblyToLLVMIR/M3B3/SpillArea(0): [..]ms
    Simple.sol:Simple:deploy/InitVerify/M3B3/SpillArea(0): [..]ms
    Simple.sol:Simple:deploy/OptimizeVerify/M3B3/SpillArea(0): [..]ms
    Simple.sol:Simple:runtime/EVMAssemblyToLLVMIR/M3B3/SpillArea(0): [..]ms
    Simple.sol:Simple.runtime:runtime/InitVerify/M3B3/SpillArea(0): [..]ms
    Simple.sol:Simple.runtime:runtime/OptimizeVerify/M3B3/SpillArea(0): [..]ms

Input Files

solx supports multiple input files. The following command compiles two Solidity files and prints the bytecode:

solx 'Simple.sol' 'Complex.sol' --bin

Solidity import remappings are passed the same way as input files, but they are distinguished by a = symbol between source and destination. The following command compiles a Solidity file with a remapping and prints the bytecode:

solx 'Simple.sol' 'github.com/ethereum/dapp-bin/=/usr/local/lib/dapp-bin/' --bin

solx does not handle remappings itself, but only passes them through to solc. Visit the solc documentation to learn more about the processing of remappings.

--libraries

Specifies the libraries to link with compiled contracts. The option accepts multiple string arguments. The safest way is to wrap each argument in single quotes, and separate them with a space.

The specifier has the following format: <ContractPath>:<ContractName>=<LibraryAddress>.

Usage:

solx 'Simple.sol' --bin --libraries 'Simple.sol:Simple=0x1234567890abcdef1234567890abcdef12345678'

--base-path, --include-path, --allow-paths

These options are used to specify Solidity import resolution settings. They are not used by solx and only passed through to solc like import remappings.

Visit the solc documentation to learn more about the processing of these options.

--output-dir

Specifies the output directory for build artifacts. Can only be used in basic CLI mode.

Usage in basic CLI mode:

$ solx 'Simple.sol' --bin --asm --metadata --output-dir './build/'
Compiler run successful. Artifact(s) can be found in directory "./build/".

$ ls './build/'
Simple_sol_Simple.asm
Simple_sol_Simple.bin
Simple_sol_Simple_llvm.asm
Simple_sol_Simple_llvm.asm-runtime
Simple_sol_Simple_meta.json
Simple_sol_Simple_runtime.asm

--overwrite

Overwrites the output files if they already exist in the output directory. By default, solx does not overwrite existing files.

Can only be used in combination with the --output-dir option.

Usage:

$ solx 'Simple.sol' --bin --output-dir './build/' --overwrite
Compiler run successful. Artifact(s) can be found in directory "./build/".

Here ./build/ already contains the artifacts emitted in the --output-dir section, so the flag has existing files to overwrite.

If the --overwrite option is not specified and the output files already exist, solx refuses to overwrite them and exits with an error:

$ solx 'Simple.sol' --bin --output-dir './build-overwrite/'
Compiler run successful. Artifact(s) can be found in directory "./build-overwrite/".

$ solx 'Simple.sol' --bin --output-dir './build-overwrite/'
? failed
Error: Refusing to overwrite an existing file "./build-overwrite/Simple_sol_Simple.bin" (use --overwrite to force).

--version

Prints the version of solx and the hash of the LLVM commit it was built with.

Usage:

solx --version

--help

Prints the help message.

Usage:

solx --help

Other I/O Modes

The mode-altering CLI options are mutually exclusive. This means that only one of the options below can be enabled at a time:

--standard-json

For the standard JSON mode usage, see the Standard JSON page.

solx Compilation Settings

The options in this section are only configuring the solx compiler and do not affect the underlying solc compiler.

--threads

Sets the number of threads used for parallel compilation. Each thread compiles a separate translation unit in a child process. By default, the number of threads equals the number of CPU cores.

Large projects can consume a lot of RAM during compilation on machines with a high number of cores. If you encounter memory issues, consider reducing the number of threads.

Usage:

solx 'Simple.sol' --bin --threads 4

--optimization / -O

Sets the optimization level of the LLVM optimizer. Available values are:

LevelMeaningHints
0No optimizationFor fast compilation during development (unsupported)
1Performance: basicFor optimization research
2Performance: defaultFor optimization research
3Performance: aggressiveBest performance for production
sSize: defaultFor optimization research
zSize: aggressiveBest size for contracts with size constraints

For most cases, it is fine to keep the default value of 3. You should only use the level z if you are ready to deliberately sacrifice performance and optimize for size.

Optimization can affect exact gas consumption, memory expansion, and the preservation of source operations. See Optimizer and Assembly Semantics.

Large contracts may hit the EVM bytecode size limit. In this case, it is recommended to use the --optimization-size-fallback option rather than setting the level to z.

Usage:

solx 'Simple.sol' --bin -O3

This option can also be set with an environment variable SOLX_OPTIMIZATION, which is useful for toolkits where arbitrary solx-specific options are not supported:

SOLX_OPTIMIZATION='3' solx 'Simple.sol' --bin

--optimization-size-fallback

Sets the optimization level to z for contracts that failed to compile due to overrunning the bytecode size constraints.

Under the hood, this option automatically triggers recompilation of contracts with level z. Contracts that were successfully compiled with the original --optimization setting are not recompiled.

For deployment, it is recommended to have this option enabled in order to mitigate potential issues with EVM bytecode size constraints on a per-contract basis. If your environment does not have bytecode size limitations, it is better to disable it to prevent unnecessary recompilations. A good example is running forge test.

Usage:

solx 'Simple.sol' --bin -O3 --optimization-size-fallback

This option can also be set with an environment variable SOLX_OPTIMIZATION_SIZE_FALLBACK, which is useful for toolkits where arbitrary solx-specific options are not supported:

SOLX_OPTIMIZATION_SIZE_FALLBACK= solx 'Simple.sol' --bin -O3

--metadata-hash

Specifies the hash format used for contract metadata.

Usage with ipfs:

$ solx 'Simple.sol' --bin --metadata-hash 'ipfs'

======= Simple.sol:Simple =======
Binary:
34601557630000008480630000001a6080396080f35b5f5ffdfe34600b57600336116016575b5f5ffd5b5060016031565b5f3560e01c633df4ddf48114600f57635a8ac02d03600b5760025b60805260206080f3fea2646970667358221220[..]64736f6c637816736f6c783a302e312e373b736f6c633a302e382e33340047

The byte array starting with a2 at the end of the bytecode is a CBOR-encoded compiler version data and an optional metadata hash.

The last two bytes of the metadata (0x0047) are not a part of the CBOR payload, but the length of it, which must be known to correctly decode the payload.

JSON representation of the CBOR payload:

{
    // Optional: included if `--metadata-hash` is set to `ipfs`.
    "ipfs": "1220bec8fa0149a786c5810200ef5a436a154cff832af68ace5beeabcbb82166cb92",

    // Required: consists of semicolon-separated pairs of colon-separated compiler names and versions.
    // `solx:<version>` is always included.
    // `solc:<version>` is only included for Solidity and Yul contracts, but not included for LLVM IR ones.
    "solc": "solx:0.1.7;solc:0.8.34"
}

For more information on these formats, see the CBOR and IPFS documentation.

--no-cbor-metadata

Disables the CBOR metadata that is appended at the end of bytecode. This option is useful for debugging and research purposes.

It is not recommended to use this option in production, as it is not possible to verify contracts deployed without metadata.

Usage:

solx 'Simple.sol' --no-cbor-metadata

--llvm-options

Specifies additional options for the LLVM framework. The argument must be a single quoted string following a = separator.

Usage:

solx 'Simple.sol' --bin --llvm-options='-key=value'

The --llvm-options option is experimental and must only be used by experienced users. All supported options will be documented in the future.

solc Compilation Settings

The options in this section are only configuring solc, so they are passed directly to its child process, and do not affect the solx compiler.

--via-ir

Switches the solc codegen to Yul a.k.a. IR.

Usage:

solx 'Simple.sol' --bin --via-ir

--evm-version

Specifies the EVM version solx will produce bytecode for. For instance, with version osaka, solx will be producing clz instructions, whereas for older EVM versions it will not.

Only the following EVM versions are supported:

  • cancun
  • prague
  • osaka (default)

Usage:

solx 'Simple.sol' --bin --evm-version 'osaka'

--metadata-literal

Tells solc to store referenced sources as literal data in the metadata output.

This option only affects the contract metadata output produced by solc, and does not affect artifacts produced by solx.

Usage:

solx 'Simple.sol' --bin --metadata --metadata-literal

--no-import-callback

Disables the default import resolution callback in solc.

This parameter is used by some tooling that resolves all imports by itself, such as Hardhat.

Usage:

solx 'Simple.sol' --no-import-callback

Multi-Language Support

solx supports input in multiple programming languages:

The following sections outline how to use solx with these languages.

--yul (or --strict-assembly)

Enables the Yul mode. In this mode, input is expected to be in the Yul language. The output works the same way as with Solidity input.

Yul input is optimized through LLVM and is not emitted as a verbatim EVM opcode sequence. See Optimizer and Assembly Semantics.

The example compiles this Yul object, Simple.yul:

object "Simple" {
    code {
        datacopy(0, dataoffset("Simple_deployed"), datasize("Simple_deployed"))
        return(0, datasize("Simple_deployed"))
    }
    object "Simple_deployed" {
        code {
            mstore(0, 42)
            return(0, 32)
        }
    }
}

Usage:

$ solx --yul 'Simple.yul' --bin

======= Simple.yul =======
Binary:
63000000298063000000105f395ff3fe602a5f5260205ff3fea164736f6c637816736f6c783a302e312e373b736f6c633a302e382e3334001e

--llvm-ir

Enables the LLVM IR mode. In this mode, input is expected to be in the LLVM IR language. The output works the same way as with Solidity input.

In this mode, every input file is treated as runtime code, while deploy code will be generated automatically by solx. It is not possible to write deploy code manually yet, but it will be supported in the future.

Unlike solc, solx is an LLVM-based compiler toolchain, so it uses LLVM IR as an intermediate representation. It is not recommended to write LLVM IR manually, but it can be useful for debugging and optimization purposes. LLVM IR is more low-level than Yul and EVM assembly in the solx IR hierarchy.

The example input Simple.ll is the optimized runtime module of Simple.sol above, as produced by --emit-llvm-ir.

Usage:

$ solx --llvm-ir 'Simple.ll' --bin

======= Simple.ll =======
Binary:
5b630000004f8063000000115f395ff3fe34600b57600336116016575b5f5ffd5b5060016031565b5f3560e01c633df4ddf48114600f57635a8ac02d03600b5760025b60805260206080f3fea164736f6c63780a736f6c783a302e312e370012

Debugging

IR Output Flags

For selective IR output, use the following flags with --output-dir:

These flags respect the --overwrite option. Without --overwrite, the compiler will refuse to overwrite existing files.

SOLX_OUTPUT_DIR Environment Variable

For debugging purposes, all intermediate build artifacts can be dumped to a directory using the SOLX_OUTPUT_DIR environment variable. This is useful for toolkits where arbitrary solx-specific options are not supported.

When this environment variable is set, solx will output all intermediate representations to the specified directory, always overwriting existing files.

The intermediate build artifacts include:

NameExtension
EVM Assemblyevmla
EthIRethir
Yulyul
LLVM IRll
LLVM Assemblyasm

Usage:

$ SOLX_OUTPUT_DIR='./debug/' solx 'Simple.sol' --bin
...
$ ls './debug/'
Simple_sol_Simple.asm
Simple_sol_Simple.ethir
Simple_sol_Simple.evmla
Simple_sol_Simple.optimized.ll
Simple_sol_Simple.unoptimized.ll
Simple_sol_Simple_runtime.asm
Simple_sol_Simple_runtime.ethir
Simple_sol_Simple_runtime.evmla
Simple_sol_Simple_runtime.optimized.ll
Simple_sol_Simple_runtime.unoptimized.ll

The output file name is constructed as follows: <ContractPath>_<ContractName>[_runtime].<Modifiers>.<Extension>.

Additionally, it is possible to dump the standard JSON input file with the SOLX_STANDARD_JSON_DEBUG environment variable:

SOLX_STANDARD_JSON_DEBUG='./debug/input.json' solx 'Simple.sol' --bin
cat './debug/input.json' | jq .

--llvm-verify-each

Enables the verification of the LLVM IR after each optimization pass. This option is useful for debugging and research purposes.

Usage:

solx 'Simple.sol' --bin --llvm-verify-each

--llvm-debug-logging

Enables the debug logging of the LLVM IR optimization passes. This option is useful for debugging and research purposes.

Usage:

solx 'Simple.sol' --bin --llvm-debug-logging