Skip to content

docs(install): remove direnv, simplify installation instructions #1315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
spomichter merged 1 commit into from
Feb 20, 2026
Merged

docs(install): remove direnv, simplify installation instructions #1315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 9 additions & 34 deletions docs/installation/nix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,42 +13,23 @@ curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix
mkdir -p "$HOME/.config/nix"; echo "experimental-features = nix-command flakes" >> "$HOME/.config/nix/nix.conf"
```

# Install Direnv (optional)

[direnv](https://direnv.net) is a convenient helper that allows you to automatically enter your nix and python env once you cd into the project dir.

You can skip this step if you intend to type `nix develop` by hand.

Following [direnv install docs](https://direnv.net/docs/installation.html) is recommended (many distros have native package support)

but a quick oneliner binary install is
```sh
curl -sfL https://direnv.net/install.sh | bash
```

# Using DimOS as a library

```sh
mkdir myproject
cd myproject
mkdir myproject && cd myproject

# if on nixos you can pull our flake
# pull the flake (needed for nix develop outside the repo)
wget https://raw.githubusercontent.com/dimensionalOS/dimos/refs/heads/main/flake.nix
wget https://raw.githubusercontent.com/dimensionalOS/dimos/refs/heads/main/flake.lock

# if using direnv (recommended)
wget https://raw.githubusercontent.com/dimensionalOS/dimos/refs/heads/main/.envrc.nix -O .envrc
direnv allow

# if using nix develop directly instead of direnv,
# nix develop
# enter the nix development shell (provides system deps)
nix develop

uv venv --python "3.12"
uv venv --python 3.12
source .venv/bin/activate

# this will just pull everything (big checkout)
# depending on what you are working on you might not need everything,
# check your respective platform guides
# install everything (depending on your use case you might not need all extras,
# check your respective platform guides)
uv pip install dimos[misc,sim,visualization,agents,web,perception,unitree,manipulation,cpu,dev]
```

Expand All @@ -60,16 +41,10 @@ export GIT_LFS_SKIP_SMUDGE=1
git clone -b dev https://github.com/dimensionalOS/dimos.git
cd dimos

# if using direnv (recommended)
cp .envrc.nix .envrc
direnv allow
# enter the nix development shell (provides system deps)
nix develop

# if using nix develop directly instead of direnv,
# nix develop

# create venv
uv venv --python 3.12

source .venv/bin/activate

uv sync --all-extras
Expand Down
41 changes: 7 additions & 34 deletions docs/installation/osx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# osx install
# macOS Install (12.6 or newer)

## macOS 12.6 or newer
```sh
# install homebrew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Expand All @@ -11,36 +10,16 @@ brew install gnu-sed gcc portaudio git-lfs libjpeg-turbo python pre-commit
curl -LsSf https://astral.sh/uv/install.sh | sh && export PATH="$HOME/.local/bin:$PATH"
```

# Install Direnv (optional)

[direnv](https://direnv.net) is a convenient helper that allows you to automatically enter your python env once you cd into the project dir.

You can skip this step if you intend to activate manually.

Following [direnv install docs](https://direnv.net/docs/installation.html) is recommended (many distros have native package support)

but a quick oneliner binary install is
```sh
curl -sfL https://direnv.net/install.sh | bash
```

# Using DimOS as a library

```sh
mkdir myproject
cd myproject

uv venv --python "3.12"
mkdir myproject && cd myproject

# if using direnv (recommended)
wget https://raw.githubusercontent.com/dimensionalOS/dimos/refs/heads/main/.envrc.venv -O .envrc
direnv allow
# if not using direnv
# source .venv/bin/activate
uv venv --python 3.12
source .venv/bin/activate

# this will just pull everything (big checkout)
# depending on what you are working on you might not need everything,
# check your respective platform guides
# install everything (depending on your use case you might not need all extras,
# check your respective platform guides)
uv pip install dimos[misc,sim,visualization,agents,web,perception,unitree,manipulation,cpu,dev]
```

Expand All @@ -52,14 +31,8 @@ export GIT_LFS_SKIP_SMUDGE=1
git clone -b dev https://github.com/dimensionalOS/dimos.git
cd dimos

# create venv
uv venv --python 3.12

# if using direnv (recommended)
direnv allow

# if not using direnv
# source .venv/bin/activate
source .venv/bin/activate

uv sync --all-extras

Expand Down
33 changes: 8 additions & 25 deletions docs/installation/ubuntu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,36 +8,16 @@ sudo apt-get install -y curl g++ portaudio19-dev git-lfs libturbojpeg python3-de
curl -LsSf https://astral.sh/uv/install.sh | sh && export PATH="$HOME/.local/bin:$PATH"
```

# Install Direnv (optional)

[direnv](https://direnv.net) is a convenient helper that allows you to automatically enter your python env once you cd into the project dir.

You can skip this step if you intend to activate manually.

Following [direnv install docs](https://direnv.net/docs/installation.html) is recommended (many distros have native package support)

but a quick oneliner binary install is
```sh
curl -sfL https://direnv.net/install.sh | bash
```

# Using DimOS as a library

```sh
mkdir myproject
cd myproject
mkdir myproject && cd myproject

uv venv --python "3.12"
uv venv --python 3.12
source .venv/bin/activate

# if using direnv (recommended)
wget https://raw.githubusercontent.com/dimensionalOS/dimos/refs/heads/main/.envrc.venv -O .envrc
direnv allow
# if not using direnv
# source .venv/bin/activate

# this will just pull everything (big checkout)
# depending on what you are working on you might not need everything,
# check your respective platform guides
# install everything (depending on your use case you might not need all extras,
# check your respective platform guides)
uv pip install dimos[misc,sim,visualization,agents,web,perception,unitree,manipulation,cpu,dev]
```

Expand All @@ -49,6 +29,9 @@ export GIT_LFS_SKIP_SMUDGE=1
git clone -b dev https://github.com/dimensionalOS/dimos.git
cd dimos

uv venv --python 3.12
source .venv/bin/activate

uv sync --all-extras

# type check
Expand Down
Loading