Getting started

folkorama hosts a lore server for you; every real operation runs through the lore command-line client. This walkthrough goes from a fresh account to files stored in lore. Each step is a real action the next one depends on - do them in order.

  1. Create an account. Sign up. If we send you a verification email, click the link in it. You land on the dashboard - create a workspace there, then come back here for the CLI steps.
  2. Create a workspace. A workspace is a private lore server on its own subdomain - we set up your loreserver instance. Open Workspaces on the dashboard and pick a subdomain (lowercase, e.g. my-studio).
  3. Install the lore CLI. Everything runs through it.
    # macOS / Linux
    curl -fsSL https://raw.githubusercontent.com/EpicGames/lore/main/scripts/install.sh | bash
    # Windows (PowerShell)
    irm https://raw.githubusercontent.com/EpicGames/lore/main/scripts/install.ps1 | iex

    In a container or CI shell with no OS keyring, set export LORE_AUTH_STORE=fallback so the CLI can store its token.

  4. Get a credential. Either create an API key on the dashboard (best for CI / headless), or run browser login from the CLI and approve it in the tab that opens.
  5. Create a repository inside your workspace. Open Repositories, create one, and copy the ready-to-use clone URL from its page. Clone by that URL - cloning by name 404s (the client can't resolve a name without a per-repo token yet).
  6. Push your first revision. From a terminal:
    lore clone lores://<your-subdomain>.…/<repo-id>
    cd <repo>
    # add some files, then:
    lore stage .
    lore commit -m "first revision"
    lore push

    The repository page has these commands pre-filled with your real URL and id - copy them from there rather than typing placeholders.

lores:// isn't a typo - the s means both connections your client makes (the metadata call and the actual file transfer) are TLS-encrypted, on every workspace, by default.