aleth

(★ 3,963)

Aleth – Ethereum C++ client, tools and libraries

File Explorer

  • .bumpversion.cfg
  • .clang-format
  • .dockerignore
  • .editorconfig
  • .gitignore
  • .gitmodules
  • .travis.yml
  • .ycm_extra_conf.py
  • appveyor.yml
  • CHANGELOG.md
  • circle.yml
  • CMakeLists.txt
  • codecov.yml
  • CODING_STYLE.md
  • CONTRIBUTING.md
  • evmc
  • LICENSE
  • README.md
  • refilltests
  • sanitizer-blacklist.txt
  • snapcraft.yaml

# Installation Guide

cmake
Prerequisites
  • Git latest
  • CMake 3.9.3 or higher
  • C++ Compiler Visual Studio 2017/2019 (Windows) or GCC/Clang (Linux/macOS)

Setup Steps

git clone --recursive https://github.com/ethereum/aleth.git

Clone the repository recursively with submodules.

mkdir build && cd build

Create and navigate to the build directory.

cmake ..

Configure the project using CMake.

cmake --build .

Build the project.

Key Commands

cmake ..

Configure the build environment using CMake.

cmake --build .

Compile the project based on the configured build files.

On Windows, you may need to specify the Visual Studio 2017 or 2019 x64 generator.

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

cmake

View Details ▼

Cross-platform build automation system, that generates recipes for native build systems.

cmake {{path/to/project_directory}}

Generate a build recipe in the current directory with `CMakeLists.txt` from a project directory:

cmake --build {{path/to/build_directory}}

Use a generated recipe in a given directory to build artifacts:

cmake --install {{path/to/build_directory}} --strip

Install the build artifacts into `/usr/local/` and strip debugging symbols:

🔍

docker run

View Details ▼

This command is an alias of `docker container run`.

tldr docker container run

View documentation for the original command:

🔍

git clone

View Details ▼

Clone an existing repository.

git clone {{remote_repository_location}} {{path/to/directory}}

Clone an existing repository into a new directory (the default directory is the repository name):

git clone --recursive {{remote_repository_location}}

Clone an existing repository and its submodules:

git clone {{[-n|--no-checkout]}} {{remote_repository_location}}

Clone only the `.git` directory of an existing repository:

🔍

git submodule

View Details ▼

Inspect, update, and manage submodules.

git submodule

View existing submodules and the checked-out commit for each one:

git submodule update --init --recursive

Install a repository's submodules (listed in `.gitmodules`):

git submodule add {{repository_url}}

Add a Git repository as a submodule of the current one:

// repository documentation