Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Live at: [flox.dev/docs](https://flox.dev/docs).

```
$ flox activate
You are now using the environment 'floxdocs'.
You are now using the environment 'floxdocs'.

λ (floxdocs) $ flox services start mkdocs
Service 'mkdocs' started.
Service 'mkdocs' started.

```
Once mkdocs service started you can preview the documentation at
Expand Down
10 changes: 5 additions & 5 deletions docs/concepts/floxhub-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Another way of working is to [push][flox-push] an environment to [FloxHub][floxh

```{ .sh }
$ flox push
Updates to myenv successfully pushed to FloxHub
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(unrelated line)
This was completely Clauded. I didn't check spaces throughout

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(unrelated line)
These aren't colorized when rendered - I'm not sure if there's an easy way to do that

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's not, really. You'd have to figure out how to wrap these specific characters in different HTML tags and then write custom CSS for them.

Updates to myenv successfully pushed to FloxHub

View the environment at: https://hub.flox.dev/myuser/myenv
Use this environment from another machine: 'flox activate -r myuser/myenv'
Expand Down Expand Up @@ -77,15 +77,15 @@ The Flox CLI indicates when an operation has been performed on the local copy (n

```text
$ flox install -r myuser/myenv ripgrep
'ripgrep' installed to environment 'myuser/myenv' (local)
'ripgrep' installed to environment 'myuser/myenv' (local)
```

When the Flox CLI detects that the local and upstream copies are out of sync (for example, you have a new local generation corresponding to the new package you installed), it will notify you with instructions on how to proceed.
For the example above, you would see the following output when activating the environment:

```text
$ flox activate -r myuser/myenv
ℹ️ Environment out of sync with FloxHub.
Environment out of sync with FloxHub.

Local:

Expand All @@ -101,7 +101,7 @@ Remote:

Use 'flox push|pull -r myuser/myenv' to fetch updates or update the environment on FloxHub.

You are now using the environment 'myuser/myenv (local)'.
You are now using the environment 'myuser/myenv (local)'.
To stop using this environment, type 'exit'
```

Expand All @@ -115,7 +115,7 @@ Running the `flox push` command syncs local changes to the upstream copy on Flox

```text
$ flox push -r myuser/myenv
Updates to myenv successfully pushed to FloxHub
Updates to myenv successfully pushed to FloxHub

View the environment at: https://hub.flox.dev/myuser/myenv
Use this environment from another machine: 'flox activate -r myuser/myenv'
Expand Down
6 changes: 3 additions & 3 deletions docs/flox-5-minutes.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Once you have the project, you can run the [`flox activate`][activate] command t

```{ .console }
$ flox activate
You are now using the environment 'flox-in-5min'.
You are now using the environment 'flox-in-5min'.
To stop using this environment, type 'exit'
```

Expand Down Expand Up @@ -167,7 +167,7 @@ Start the `stopwatch` service with the `flox services start` command:

```{ .console }
$ flox services start
Service 'stopwatch' started.
Service 'stopwatch' started.
```

Let's make sure it's running:
Expand Down Expand Up @@ -198,7 +198,7 @@ We don't want the service to run forever, so let's stop it with the `flox servic

```{ .console }
$ flox services stop
Service 'stopwatch' stopped
Service 'stopwatch' stopped
```

A _really cool_ feature of Flox is that if you were to exit the environment by running `exit` or pressing `Ctrl-D`, the services running in the environment would be automatically stopped.
Expand Down
12 changes: 6 additions & 6 deletions docs/languages/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This will suggest a few commands you can run next:

```console
$ flox init
Created environment 'new-python-project' (x86_64-linux)
⚡︎ Created environment 'new-python-project' (x86_64-linux)

Next:
$ flox search <package> <- Search for a package
Expand Down Expand Up @@ -86,7 +86,7 @@ This will show a message indicating the package was successfully installed:

```console
$ flox install python311Full
'python311Full' installed to environment 'new-python-project'
'python311Full' installed to environment 'new-python-project'
$ flox list
python311Full: python311Full (python3-3.11.9)
```
Expand Down Expand Up @@ -126,8 +126,8 @@ You will see output indicating that the packages were successfully installed. If

```console
$ flox install python311Packages.numpy python311Packages.pandas
'numpy' installed to environment 'new-python-project'
'pandas' installed to environment 'new-python-project'
'numpy' installed to environment 'new-python-project'
'pandas' installed to environment 'new-python-project'
```

### Activate the new environment
Expand All @@ -142,7 +142,7 @@ This will put you into a new subshell with your environment active:

```console
$ flox activate
You are now using the environment 'new-python-project'.
You are now using the environment 'new-python-project'.
To stop using this environment, type 'exit'

flox [new-python-project] $
Expand Down Expand Up @@ -274,7 +274,7 @@ You should see output indicating that the Python virtual environment has been cr

```console
$ flox activate
You are now using the environment 'eralchemy'.
You are now using the environment 'eralchemy'.
To stop using this environment, type 'exit'

Creating python virtual environment in /home/floxfan/eralchemy/.flox/cache/python
Expand Down
12 changes: 6 additions & 6 deletions docs/tutorials/build-and-publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ We'll create a directory called `myproject` and create a Flox environment inside
$ mkdir myproject
$ cd myproject
$ flox init
Created environment 'myproject' (aarch64-darwin)
⚡︎ Created environment 'myproject' (aarch64-darwin)

Next:
$ flox search <package> <- Search for a package
Expand All @@ -30,7 +30,7 @@ Since we're using Go, we'll want to install Go:

```text
$ flox install go
'go' installed to environment 'myproject'
'go' installed to environment 'myproject'
$ # let's see what version of Go we have
$ flox list
go: go (1.24.1)
Expand All @@ -42,7 +42,7 @@ Start by activating the environment so that we have our Go application available

```text
$ flox activate
You are now using the environment 'myproject'.
You are now using the environment 'myproject'.
To stop using this environment, type 'exit'

flox [myproject] $ go mod init hello
Expand Down Expand Up @@ -130,7 +130,7 @@ building '/nix/store/g3z03h4p2xa9rf6y78d0xamryggawvha-hello-0.0.0.drv'...
hello-0.0.0> patching script interpreter paths in /nix/store/2hc9mjxs6wqcd8cscw9ll650jv1k6wn1-hello-0.0.0/bin/hello
Completed build of hello-0.0.0 in local mode

Build completed successfully. Output created: ./result-hello
⚡︎ Build completed successfully. Output created: ./result-hello
```

It worked!
Expand Down Expand Up @@ -184,7 +184,7 @@ hello-opt-1.0.0> signing /nix/store/nbykbq9fy0z67hhlf1kvf8wk7wb29x59-hello-opt-1
hello-opt-1.0.0> patching script interpreter paths in /nix/store/nbykbq9fy0z67hhlf1kvf8wk7wb29x59-hello-opt-1.0.0/bin/hello
Completed build of hello-opt-1.0.0 in local mode

Build completed successfully. Output created: ./result-hello-opt
⚡︎ Build completed successfully. Output created: ./result-hello-opt
```

## Publish the package
Expand Down Expand Up @@ -246,7 +246,7 @@ Now that we know it's available, let's install it:

```text
flox [myproject] $ flox install myuser/hello
'myuser/hello' installed to environment 'myproject'
'myuser/hello' installed to environment 'myproject'
```

## Conclusion
Expand Down
20 changes: 10 additions & 10 deletions docs/tutorials/composition.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Then create a new environment called `python_env` in it with the [`flox init`][f
```console
$ mkdir myproject && cd myproject
$ flox init -d python_env
Created environment 'python_env' (aarch64-darwin)
⚡︎ Created environment 'python_env' (aarch64-darwin)

Next:
$ flox search <package> <- Search for a package
Expand All @@ -41,7 +41,7 @@ Now install `python312` and `poetry` to this environment with the [`flox install

```console
$ flox install -d python_env python312 poetry
'python312', 'poetry' installed to environment 'python_env'
'python312', 'poetry' installed to environment 'python_env'
```

Now you can push this environment to [FloxHub][floxhub].
Expand All @@ -50,7 +50,7 @@ Let's start by pushing the environment to FloxHub:

```console
$ flox push -d python_env
python_env successfully pushed to FloxHub
python_env successfully pushed to FloxHub

Use 'flox pull myuser/python_env' to get this environment in any other location.

Expand All @@ -72,7 +72,7 @@ Let's create a new copy of this environment in a directory called `new_python_pr

```console
$ flox pull -d new_python_project --copy myuser/python_env
Created path environment from myuser/python_env.
⚡︎ Created path environment from myuser/python_env.

You can activate this environment with 'flox activate'
```
Expand Down Expand Up @@ -125,7 +125,7 @@ Let's create a environment in a `composed_python_project` directory.

```console
$ flox init -d composed_python_project
Created environment 'composed_python_project' (aarch64-darwin)
⚡︎ Created environment 'composed_python_project' (aarch64-darwin)

Next:
$ flox search <package> <- Search for a package
Expand Down Expand Up @@ -163,7 +163,7 @@ When there is more than one environment in this list, the order of the environme
Once you save and exit you should see this output:

```console
Environment successfully updated.
Environment successfully updated.
ℹ The following manifest fields were overridden during merging:
- This environment set:
- options.systems
Expand Down Expand Up @@ -216,7 +216,7 @@ Let's add the `pytest` package:

```console
$ flox install -d composed_python_project python312Packages.pytest
'pytest' installed to environment 'composed_python_project'
'pytest' installed to environment 'composed_python_project'
```

Note that the message says the package was installed to the `composed_python_project` environment.
Expand All @@ -233,14 +233,14 @@ Let's add that package to `python_env`:

```console
$ flox install -d python_env python312Packages.hypothesis
'hypothesis' installed to environment 'myuser/python_env'
'hypothesis' installed to environment 'myuser/python_env'
```

Now let's propagate those changes to the composed environment:

```console
$ flox include upgrade -d composed_python_project
Upgraded 'composed_python_project' with latest changes to:
Upgraded 'composed_python_project' with latest changes to:
- 'python_env'
```

Expand All @@ -266,7 +266,7 @@ Push the additional package that we installed to `myuser/python_env` earlier:

```console
$ flox push -d python_env
Updates to python_env successfully pushed to FloxHub
Updates to python_env successfully pushed to FloxHub

Use 'flox pull myuser/python_env to get this environment in any other location.
```
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorials/creating-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Initialized empty Git repository in /Users/your-username/example-project/.git/

```console
$ flox init
Created environment example-project (aarch64-darwin)
⚡︎ Created environment example-project (aarch64-darwin)

Next:
$ flox search <package> <- Search for a package
Expand Down Expand Up @@ -98,7 +98,7 @@ Once you've found the right package, you can install it with

```console
$ flox install nodejs
'nodejs' installed to environment example-project at /Users/myuser/example-project
'nodejs' installed to environment example-project at /Users/myuser/example-project
```

!!! note "Note"
Expand All @@ -118,7 +118,7 @@ Use `flox show <package>` to see available versions

```console
$ flox install mkcert
'mkcert' installed to environment example-project at /Users/myuser/example-project
'mkcert' installed to environment example-project at /Users/myuser/example-project
```

## Enter and use the environment
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorials/cuda.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,9 +151,9 @@ In this case we'll install the following packages:

```console
$ flox install python3 flox-cuda/python3Packages.torch flox-cuda/python3Packages.torchvision
'python3' installed to environment 'mnist'
⚠️ 'torch' installed only for the following systems: x86_64-linux, aarch64-linux
⚠️ 'torchvision' installed only for the following systems: x86_64-linux
'python3' installed to environment 'mnist'
! 'torch' installed only for the following systems: x86_64-linux, aarch64-linux
! 'torchvision' installed only for the following systems: x86_64-linux

```

Expand Down
8 changes: 4 additions & 4 deletions docs/tutorials/default-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ and initialize a FloxHub environment under your account:

```{ .bash }
flox auth status || flox auth login
Authentication complete
Logged in as <youruser>
Authentication complete
Logged in as <youruser>

flox init -r <youruser>/default
```
Expand Down Expand Up @@ -122,7 +122,7 @@ like you would expect from your system's package manager:

```console
$ flox install hello
'hello' installed to environment 'default'
'hello' installed to environment 'default'
```

It worked (though you shouldn't be surprised; Flox is awesome)!
Expand All @@ -144,7 +144,7 @@ flox install -r <your username>/default ~ hello
When you do this, you should see the following output, indicating success:

```console
'hello' installed to environment 'default'
'hello' installed to environment 'default'
```

## Customization
Expand Down
18 changes: 9 additions & 9 deletions docs/tutorials/layering-multiple-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ Here we are installing `curl`, `gitFull`, `gnupg`, `inetutils`, `tree`, and

```console
$ flox install curl gitFull gnupg inetutils tree vim
'curl' installed to environment default at /Users/youruser
'gitFull' installed to environment default at /Users/youruser
'gnupg' installed to environment default at /Users/youruser
'inetutils' installed to environment default at /Users/youruser
'tree' installed to environment default at /Users/youruser
'vim' installed to environment default at /Users/youruser
'curl' installed to environment default at /Users/youruser
'gitFull' installed to environment default at /Users/youruser
'gnupg' installed to environment default at /Users/youruser
'inetutils' installed to environment default at /Users/youruser
'tree' installed to environment default at /Users/youruser
'vim' installed to environment default at /Users/youruser
```

Let's inspect the contents of the environment with [`flox list`][flox_list]:
Expand Down Expand Up @@ -75,7 +75,7 @@ Use [`flox init`][flox_init] from the `material-ui` directory that we are in.

```console
flox [default] $ flox init
Created environment material-ui (aarch64-darwin)
⚡︎ Created environment material-ui (aarch64-darwin)

Next:
$ flox search <package> <- Search for a package
Expand All @@ -88,7 +88,7 @@ This project only requires `yarn` so let's install it with

```console
flox [default] $ flox install yarn
'yarn' installed to environment material-ui at /Users/youruser/material-ui
'yarn' installed to environment material-ui at /Users/youruser/material-ui
```

Now we're ready to do development on this project!
Expand All @@ -111,7 +111,7 @@ You can use `flox envs` to see the environments you have activated.

```console
$ flox envs
Active environments:
⚡︎ Active environments:
material-ui /home/youruser/material-ui
default /home/youruser

Expand Down
Loading