Getting Started

Three pieces on your own computer, installed once and in this order. After that, everything happens in Simorg Desktop or in the Logos in your browser.

$$$ComputerSetup$$$

$$$Steps items="Docker|Where each agent's container runs. Use the one you already have; The machine service|Connects this computer to Simorg and runs the agents placed on it. Simorg Desktop installs it for you; Simorg Desktop|The app in your menu bar and the simorg command. Sign in and watch your agents"$$$

1. Docker

Agents run in containers, so the computer needs Docker. Docker Desktop, OrbStack, Rancher Desktop, Colima and Docker Engine on Linux all work. Simorg finds whichever you have, running or not, and never installs, updates or bundles one itself.

To check from a terminal:

""" docker --version """ Docker version 27.3.1, build ce12230 !!!!

No Docker yet? Get it from Docker's own page: Docker Desktop for macOS and Windows, or Docker Engine for Linux.

2. The Simorg machine service

The machine service, simorgm, is a small program with no window of its own. It holds this computer's one connection to Simorg, keeps you signed in, and starts, watches and stops each agent's container. It runs as you, starts when you log in, and asks for an administrator's password once, while it is installed.

You rarely install it by hand. The first time Simorg Desktop opens on a computer without it, it says so and offers Install: press it, give your system's administrator password once, and the app connects when it is done. Nothing is installed until you press it. On a server with no screen, or to do it yourself on macOS or Linux, one command installs it:

""" curl -fsSL https://install.simorg.tech/simorgm | sh """ Simorg machine service 0.1.0 for linux/x64 simorgm_0.1.0-1_amd64.deb (7097940 bytes) checksum verified The Simorg machine service 0.1.0 is installed. !!!!

It picks the package your system installs natively (a .pkg on macOS, a .deb or an .rpm on Linux, a tarball on any other distribution), checks its SHA-256, and hands it to the system's own installer. Run it again to upgrade, add --dry-run to see what it would install, and remove the service with the same package manager that installed it.

$$$AlertBox type=HINT title=Why two programs? message=The machine service does the work, and it keeps going when every window is closed, so your agents keep running too. Simorg Desktop is how you see and steer it, as an app or as the simorg command, and you can quit or reinstall it at any time. On a server with no screen, the service and the simorg command are all you need.$$$

3. Simorg Desktop

Simorg Desktop is the app in your menu bar or notification area, and the simorg command in your terminal. Both are front ends of the machine service, so they never disagree about who is signed in or what is running. It is free software under GPL-3.0, with one build per operating system.

$$$ToPageLinker keyword=Get Simorg Desktop on Logos toRoute=/logos/milad/ashimashi/simorg-desktop$$$

Open it and sign in with your Simorg account. Signing in is what registers the computer: there is no token to copy. It then asks you to name this computer and checks that it can run an agent, once.

What it runs on

Next

With the three pieces in place, create an agent and place it on this computer.

$$$ToPageLinker keyword=Get your first agent running toRoute=/docs/platform/your-first-agent$$$