Skip to content

Commit

Permalink
docs: warn that mise is not a dependency manager
Browse files Browse the repository at this point in the history
  • Loading branch information
syhol committed Jan 13, 2025
1 parent 033aa14 commit b5058b1
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 1 deletion.
5 changes: 5 additions & 0 deletions docs/dev-tools/backends/cargo.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Cargo Backend

::: warning
Mise is not a replacement for a project dependency manager. Please continue to use `cargo`
to manage your project's package dependencies.
:::

You may install packages directly from [Cargo Crates](https://crates.io/) even if there
isn't an asdf plugin for it.

Expand Down
5 changes: 5 additions & 0 deletions docs/dev-tools/backends/dotnet.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Dotnet backend

::: warning
Mise is not a replacement for a project dependency manager. Please continue to use `nuget`
or another tool to manage your project's package dependencies.
:::

The code for this is inside the mise repository at [`./src/backend/dotnet.rs`](https://github.com/jdx/mise/blob/main/src/backend/dotnet.rs).

## Usage
Expand Down
5 changes: 5 additions & 0 deletions docs/dev-tools/backends/gem.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# gem Backend

::: warning
Mise is not a replacement for a project dependency manager. Please continue to use `gem`
to manage your project's package dependencies.
:::

mise can be used to install CLIs from RubyGems. The code for this is inside of the mise repository at [`./src/backend/gem.rs`](https://github.com/jdx/mise/blob/main/src/backend/pipx.rs).

## Dependencies
Expand Down
5 changes: 5 additions & 0 deletions docs/dev-tools/backends/go.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Go Backend <Badge type="warning" text="experimental" />

::: warning
Mise is not a replacement for a project dependency manager. Please continue to use `go mod`
to manage your project's package dependencies.
:::

You may install packages directly via [go install](https://go.dev/doc/install) even if there
isn't an asdf plugin for it.

Expand Down
7 changes: 6 additions & 1 deletion docs/dev-tools/backends/npm.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# npm Backend

You may install packages directly from [npmjs.org](https://npmjs.org/) even if there
::: warning
Mise is not a replacement for a project dependency manager. Please continue to use `npm`, `yarn`,
`pnpm`, `bun`, or another tool to manage your project's package dependencies.
:::

You may install tools directly from [npmjs.org](https://npmjs.org/) even if there
isn't an asdf plugin for it.

The code for this is inside of the mise repository at [`./src/backend/npm.rs`](https://github.com/jdx/mise/blob/main/src/backend/npm.rs).
Expand Down
5 changes: 5 additions & 0 deletions docs/dev-tools/backends/pipx.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# pipx Backend

::: warning
Mise is not a replacement for a project dependency manager. Please continue to use `pip`, `uv`,
`poetry`, or another tool to manage your project's package dependencies.
:::

pipx is a tool for running Python CLIs in isolated virtualenvs. This is necessary for Python CLIs
because it prevents conflicting dependencies between CLIs or between a CLI and Python projects. In essence,
this backend lets you add Python CLIs to mise.
Expand Down
5 changes: 5 additions & 0 deletions docs/dev-tools/backends/spm.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# SPM Backend <Badge type="warning" text="experimental" />

::: warning
Mise is not a replacement for a project dependency manager. Please continue to `swift`
to manage your project's package dependencies.
:::

You may install executables managed by [Swift Package Manager](https://www.swift.org/documentation/package-manager) directly from GitHub releases.

The code for this is inside of the mise repository at [`./src/backend/spm.rs`](https://github.com/jdx/mise/blob/main/src/backend/spm.rs).
Expand Down

0 comments on commit b5058b1

Please sign in to comment.