# flux

> Flux is a free, open source, MIT licensed command line package manager for JavaScript and Node.js that installs packages from the npm registry faster than npm and pnpm, and ships both as an npm package and as a single self contained binary with no runtime.

- Name: flux
- Package: @iamgautamsuthar/flux
- Version: 0.2.1 (alpha)
- License: MIT
- Author: Gautam Suthar
- Website: https://flux.gautamsuthar.in
- Documentation: https://flux.gautamsuthar.in/docs
- Source: https://github.com/callmegautam/flux
- Package page: https://www.npmjs.com/package/@iamgautamsuthar/flux

## Install

```sh
npm install -g @iamgautamsuthar/flux            # needs Node.js 18 or later
curl -fsSL https://raw.githubusercontent.com/callmegautam/flux/main/install.sh | sh   # Linux and macOS, no runtime needed
irm https://raw.githubusercontent.com/callmegautam/flux/main/install.ps1 | iex        # Windows PowerShell
```

## Docs

- [Full text of this site](https://flux.gautamsuthar.in/llms-full.txt): every command, limitation and answer in one file.
- [Documentation](https://flux.gautamsuthar.in/docs): installation, commands, configuration, limitations, roadmap.
- [Commands](https://flux.gautamsuthar.in/docs#commands): init, install, uninstall, reinstall, update, list, outdated, info, run, clear.
- [Configuration](https://flux.gautamsuthar.in/docs#config): cache location and environment variables.
- [Limitations](https://flux.gautamsuthar.in/docs#limits): what flux cannot do yet.
- [Roadmap](https://flux.gautamsuthar.in/docs#roadmap): what is planned next.
- [FAQ](https://flux.gautamsuthar.in/#faq): the questions people ask before installing it.

## Optional

- [Releases](https://github.com/callmegautam/flux/releases): prebuilt binaries and checksums.
- [Issues](https://github.com/callmegautam/flux/issues): open bugs and tasks.
- [Contributing](https://github.com/callmegautam/flux/blob/main/docs/CONTRIBUTING.md): how to send a change.
- [License](https://github.com/callmegautam/flux/blob/main/LICENSE): MIT.