Skip to content

Getting started Developer Experience #32

@suyashcjoshi

Description

@suyashcjoshi

Issue: Missing UID/GID setup in Getting Started docs (Mac OS)

While following the getting started guide on MacOS Sonoma, I encountered the known error related to missing UID/GID.

It would be helpful to surface this earlier in the documentation, as it’s currently only mentioned when in the docker-compose.yml file.

Suggested improvement:
Include a step to create a .env file with the required variables:

curl https://start.orbitalhq.com > docker-compose.yml
echo -e "UID=$(id -u)\nGID=$(id -g)" > .env
docker compose up -d

Additional small suggestions:

  • Make the full CLI setup block easily copyable
  • Add a prerequisite note to ensure Docker Desktop is running
  • Provide a Markdown version of the developer docs for better LLM/agent compatibility

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions