MacOS

Card key

docs_f90j31tm

Status

Draft

Card type

base/cardTypes/page

Labels

Owner

N/A

Information classification

internal

Recommended method for macOS

On macOS, the easiest way to try Cyberismo is likely by using a container platform such as Docker or Podman.

Building and running Cyberismo locally from source

Prerequisites

Install Git. While Cyberismo does not directly depend on Git, you will need it to manage Cyberismo content, such as when installing Cyberismo modules. Git installation guide: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git

Install Node.js. The currently supported Node.js version is the latest LTS, v20.10.0. Node.js is downloadable from https://nodejs.org/.

When building Cyberismo on macOS, there is a utility script which you can use to install a minimal Python distribution Miniconda and the required dependencies under the vendor directory in the Cyberismo main directory. Instructions are provided below.

Building

Take the following steps:

  1. Clone the source repository:

    $ git clone https://github.com/CyberismoCom/cyberismo.git

  2. Change to the source directory. If you have already cloned the repository earlier, remember to pull the latest changes:

    $ cd cyberismo
$ git pull origin main # Optional

  3. Install pnpm with npm command:

    $ npm install -g pnpm

  4. Execute the following commands:

    $ pnpm setup
$ pnpm install
$ pnpm build
$ pnpm link -g

  5. On macOS, you can install the dependencies with

    $ pnpm install-dev-packages

Running

After building and installing, run cyberismo --help to see the command line help.