Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Environment Setup

StartOS machine

You will need a computer running StartOS to test your package. Follow the flashing guide to install StartOS on a physical device or VM.

Docker

Docker is needed to convert docker images to StartOS images.

Make

Make is needed to streamline builds and produce s9pk binaries.

NodeJS v22 (latest LTS)

NodeJS is needed to compile the Typescript in your StartOS package.

SquashFS

SquashFS is needed to pack the compiled Javascript into a SquashFS file

Linux (Debian-based)
sudo apt install squashfs-tools squashfs-tools-ng
Mac
brew install squashfs

Start CLI

start-cli is needed to interact with StartOS from the command line.

  1. Clone the StartOS repo

    https://github.com/Start9Labs/start-os.git
    
  2. Initialize the git submodules

    git submodule update --init --recursive
    
  3. Build Start CLI

    make cli
    
  4. Initialize Start CLI

    start-cli init
    

    This will generate a .startos directory inside your home directory. This directory will contain a newly-generated developer.key.pem, used to sign packages, as well as a default config.yaml, which can be edited to customize and streamline your developer experience.