Getting Sen¶
There are three ways to get Sen, depending on what you want to do:
- Try Sen quickly on Linux without setting up Conan: use the quick installer.
- Use Sen as a dependency in your project: use the Conan package.
- Install Sen on a machine without an internet-facing toolchain (Windows, air-gapped Linux): use the release zip packages.
If you want to compile Sen yourself, see Building Sen from source.
Quick install (Linux)¶
A single POSIX sh script. No Conan, no sudo, no system files touched.
1. Install:
curl -sSf https://raw.githubusercontent.com/airbus/sen/main/resources/installer/install.sh | sh -s -- 0.5.2
2. Activate (and append the same line to your shell rc to load Sen on every new shell):
3. Check:
What the installer prints
Sen Installer v0.2.0
▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬
Configuration
Version 0.5.2
Toolchain gcc 12.4.0
Arch / OS x86_64-linux
Prefix /home/alice/.sen/0.5.2-x86_64-linux-gcc-12.4.0
✓ Downloaded sen-0.5.2-x86_64-linux-gcc-12.4.0-release.tar.gz (42M)
✓ Verified sha256 checksum
✓ Extracted into /home/alice/.sen/0.5.2-x86_64-linux-gcc-12.4.0
✓ Cached CLI completions (bash, zsh, fish)
✓ Wrote integrity manifest
✓ Wrote activate scripts
✓ Refreshed cached installer
✓ Updated 'current' to 0.5.2-x86_64-linux-gcc-12.4.0
──────────────────────────────────────────────────────────────────────
✓ Sen 0.5.2-x86_64-linux-gcc-12.4.0 installed.
Activate this build:
bash/zsh . /home/alice/.sen/current/activate
fish source /home/alice/.sen/current/activate.fish
Different versions, toolchains, non-interactive
Run with no arguments to list the available releases:
A release with multiple toolchains (gcc, clang, ...) opens an interactive menu. Skip it by pinning a toolchain explicitly, or run fully non-interactively:
Switching versions and pinning a specific build
~/.sen/current is a symlink to the most recently installed build. Running sh install.sh <other-version>
flips the symlink, even if that version was already installed.
To pin a specific build, source the per-build path directly instead of current/:
The activate scripts strip any prior ~/.sen/-rooted entries from PATH and friends, so re-sourcing or
switching is idempotent.
What activate sets, and how to uninstall
Sourcing the activate file exports SEN_PREFIX, prepends the build's bin/ to PATH and to
LD_LIBRARY_PATH, and points CMAKE_PREFIX_PATH at the prefix so find_package(sen) works.
To uninstall:
Then drop the source ...activate line from your shell rc.
For environment variables, the security model, and the full set of options, see
resources/installer/architecture.md.
Using Sen in your project (Conan)¶
Sen ships as a Conan package. Publication on Conan-Center is on the roadmap; in the meantime the package is consumed from the project's repository.
The recipe sets cmake_find_mode = "none" (in conanfile.py), so Conan does not generate a synthetic
senConfig.cmake for downstream consumers. Instead, your build picks up Sen's own
<prefix>/cmake/sen/sen-config.cmake via the CMAKE_PREFIX_PATH that CMakeDeps populates: find_package(sen)
"just works" once the toolchain file is loaded.
- Add a Conan configuration file (
conanfile.txtorconanfile.py) at the top level of your project and list Sen as a dependency. - Make sure you have a Conan profile that matches your host. If this is your first time using Conan, run
conan profile detectonce: it inspects your installed compiler, OS, and architecture and writes~/.conan2/profiles/default. Without a profile, the next step errors withProfile 'default' doesn't exist. - Resolve, build, and install the dependencies before running CMake:
Always pass --build=missing. Without it, Conan refuses to build any dependency that doesn't already have a
matching binary in its cache, which is rarely what you want on a fresh checkout.
Conan set-up
Install or upgrade Conan with:
Create a profile for your environment in <HOME>/.conan2/profiles:
[settings]
arch=x86_64
build_type=Release
compiler=gcc
compiler.cppstd=17
compiler.libcxx=libstdc++11
compiler.version=15
os=Linux
[conf]
tools.build:compiler_executables={"c": "gcc-15", "cpp": "g++-15"}
Sen recommends Ninja Multi-Config as the CMake generator. Set it once in <HOME>/.conan2/global.conf:
The Sen repository ships ready-to-use profiles in .conan/profiles (sen_gcc, sen_clang, sen_msvc,
sen_build_docs). They target Sen's CI baseline (Linux x86_64, gcc 12 / clang): useful if you need to
reproduce a CI build, less so as a default. Install one with:
For different compiler versions, prefer conan profile detect over the bundled profiles. See
Building Sen from source for the full walk-through.
Example conanfile
Replace x.y.z with the Sen version you want. The recipe derives its version from git describe --tags, so
a tagged release reads as 0.5.2 while an in-between commit reads as 0.5.2-5-gc6625265 (5 commits past tag
0.5.2, at hash c6625265).
from conan import ConanFile
from conan.tools.cmake import CMake, cmake_layout
class ProjectConfig(ConanFile):
settings = "os", "arch", "compiler", "build_type"
generators = "CMakeDeps", "CMakeToolchain"
def requirements(self):
self.requires("sen/x.y.z")
def layout(self):
cmake_layout(self)
def build(self):
cmake = CMake(self)
cmake.configure()
cmake.build()
Manual release packages¶
For Windows or environments where the quick installer is not an option, download the release archive for your
platform from the Releases page and extract it anywhere. The extracted
directory is <sen_path> in the snippets below.
export SEN_PREFIX=<sen_path>
# Sen binaries on PATH. Sen finds its own shared libraries through its run path, so this is all
# that running sen needs.
export PATH="$SEN_PREFIX/bin:$PATH"
An application you build against Sen has to find those libraries itself. Give it a run path of its own, or tell the loader where to look:
In your project's CMakeLists.txt, point CMake at the prefix and pull Sen in with find_package:
Sen installs its CMake config under <prefix>/cmake/sen/sen-config.cmake. CMake's standard search does not reach
that from <prefix> alone, so the /cmake suffix is required.
Building from source¶
If you want to compile Sen yourself (to track main, patch the code, or run on a platform without a release
artifact), see Building Sen from source.
If your editor supports devcontainers, the repository ships one under .devcontainer/. It builds the
same environment the pipeline uses, from tools/ci/Dockerfile, so you do not have to install
compilers or Conan yourself.
Build options
Component selection
mode is the Conan-level switch; it picks which components compile and which
deps Conan fetches.
| Mode | Components enabled |
|---|---|
barebones |
none - libs only, for embedding Sen as a library |
basic |
shell, ether (minimum interactive set) |
full |
every component (default) |
conan install . --profile=sen_gcc -o sen/*:mode=barebones --build=missing
conan install . --profile=sen_gcc -o sen/*:mode=basic --build=missing
Per-component Conan options are deliberately not exposed (combinatorial package_id). Developers skip building specific components at the CMake step:
conan install . --profile=sen_gcc --build=missing
cmake --preset conan-gcc-release -DSEN_BUILD_TRACY=OFF -DSEN_BUILD_EXPLORER=OFF
The CMake override doesn't change what Conan fetched. Components beyond mode
can't be enabled this way (their deps weren't fetched).
Developer-facing flags
Examples, tests, static analysis, coverage, sanitizers, and documentation are exposed as Conan
options. All default to off. Turn on what you need with -o sen/*:…=True.
| Option | Default | Maps to |
|---|---|---|
with_examples |
False |
-DSEN_BUILD_EXAMPLES=ON |
with_tests |
False |
-DSEN_BUILD_TESTS=ON |
with_clang_tidy |
False |
-DSEN_DISABLE_CLANG_TIDY=OFF (polarity flipped) |
with_coverage |
False |
-DSEN_COVERAGE_ENABLE=ON |
with_docs |
False |
-DSEN_BUILD_DOCS=ON and pulls doxygen as a tool requirement |
sanitizer |
"none" |
-DSEN_USE_SANITIZER=None/ASanUBSan/Thread for none/address/thread |
Options are applied at conan install time — that's the step that generates the build files. The
subsequent conan build (or a direct cmake --build) just compiles with the settings already baked
in; the -D mappings above are for users invoking CMake without Conan.
# Configure a build that compiles the test suite with the address sanitizer
conan install . --profile=sen_gcc -o sen/*:with_tests=True -o sen/*:sanitizer=address --build=missing
Building the docs
with_docs=True pulls doxygen automatically, but doxygen itself needs compiler.cppstd=20
(set per-dep), which has to come from a profile rather than from the recipe. Sen ships a
sen_build_docs profile that sets both, so the one-liner for docs is:
mkdocs and graphviz are not Conan-managed - install them via pip install -r docs/requirements.txt
and your platform package manager.
What the build needs (toolchain, network, time)
Toolchain. Sen's own build gets its tools as Conan tool requirements: CMake, Ninja,
GTest — and Node.js 22 whenever the jsonrpc component is enabled (any mode above basic),
because the build generates the @sen/client TypeScript types, installs its npm
dependencies, and bakes the Web Explorer bundle into the binary. Building the third-party
packages from source is different: their recipes use the system's cmake and pkg-config,
so have both installed before the first conan install.
Don't install Node for the build; the pinned toolchain version comes with conan install.
(The TS packages' dev loops — npm run dev, vitest on the host — do use your own
Node >= 22; see components/jsonrpc/clients/typescript/README.md.)
Network. The first conan install/conan build fetches from Conan Center and, for
the browser stack, from the npm registry during the build itself (npm ci). Behind a
proxy, make both reachable — or skip the web stack entirely: build -o "sen/*:mode=basic",
or stay in full mode and pass -DSEN_BUILD_JSONRPC_TS_CLIENT=OFF -DSEN_BUILD_WEBEXPLORER=OFF
at the CMake step.
Time. The first full-mode build compiles every third-party dependency plus the whole
tree; on a typical developer machine expect on the order of half an hour to an hour.
Subsequent builds are incremental. ccache shortens rebuilds — CI simply prepends the
ccache masquerade directory to PATH before building.
Windows. The browser stack is currently unverified on Windows (standard tests are disabled there, see SEN-1725); the C++ tree builds with MSVC.
For enabling and running the test suite, see Running the Tests.