chromebrew/README.md

<div align="center">
  <img src="images/brew.png" alt="Chromebrew icon">
  <h1>Chromebrew</h1>
  <p>The Missing Package Manager For Chrome OS</p>
</div>

## Chat With Us

> [!NOTE]
> Discord is not currently syncing messages with Slack

<div>
  <a href="mailto:crewonslack@gmail.com?subject=Slack invitation link request&amp;body=This email is auto-generated by README.md" target="_blank"><img src="./images/slack.svg" alt="Slack Invite" align="middle"></a>
  <a href="https://discord.gg/QRrzBXN" target="_blank"><img src="./images/discord.svg" alt="Discord Invite" align="middle"></a>
</div>

## Overview

Chromebooks with ChromeOS run a Linux kernel. The only missing pieces to use them as full-featured Linux distro were gcc and make with their dependencies. Well, these pieces aren't missing anymore. Say hello to Chromebrew!

## Prerequisites

You will need a Chromebook with developer mode enabled. To do so, select your device on [the ChromiumOS Wiki](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices) and follow the instructions listed there.

> [!WARNING]
> Please be aware of the fact that developer mode is insecure if not properly configured.

<a id="set_passwd" /> <!-- for reference in installation section -->
> [!TIP]
> Setting a password as instructed in the VT-2 login screen is recommended. It is also recommended to enable signed boot:
>
> ```bash
> sudo chromeos-setdevpasswd
> sudo crossystem dev_boot_signed_only=1
> ```

## Supported Systems

| Architecture | Supported? |
|:------------:|:----------:|
| x86_64       | Yes        |
| i686         | Yes\*      |
| armv7l       | Yes        |
| aarch64      | Yes        |

\* _We can only provide limited support for i686 since Google has discontinued support. Although we can no longer support GUI apps, we will try to continue to support CLI programs._

## Installation

> [!IMPORTANT]
> The beta, dev, and Canary channels are ***not*** supported and should ***not*** be used with Chromebrew. Failure to take notice of this warning will cause major issues with your Chromebrew installation.
>
> See issue [#2890](https://github.com/chromebrew/chromebrew/issues/2890) and the [FAQ](https://github.com/chromebrew/chromebrew/wiki/FAQ) for more details.

> [!WARNING]
> On ChromeOS M117+, the Chromebrew installer will not work in `crosh` anymore due to the security changes introduced in ChromeOS M117.

Open a VT-2 terminal session with <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>-></kbd> and login with the `chronos` user and password if set [above](#set_passwd). *(if you are unable to do this, please have a second look at the prerequisites and make sure your Chromebook is in developer mode)*

Then run the installation script below:

```bash
bash <(curl -L git.io/vddgY) && . ~/.bashrc
```

## Help

Please check out the [wiki](https://github.com/chromebrew/chromebrew/wiki) to find out more information about Chromebrew including helpful tips, resource links and frequently asked questions.

Also please check existing [issues](https://github.com/chromebrew/chromebrew/issues) before submitting a new one.

## Usage

```text
crew <command> <package1> [<package2> ...]
```

Where available commands are:

| Command      | Description |
|:------------:|:------------|
| build        | build package(s) from source and store the archive and checksum in the current working directory |
| check        | check packages(s) |
| const        | display constant(s) |
| deps         | display dependencies of package(s) |
| download     | download package(s) to CREW_BREW_DIR (/usr/local/tmp/crew by default), but don't install |
| files        | display installed files of package(s) |
| help         | get information about command usage |
| install      | install package(s) along with dependencies after prompting for confirmation |
| list         | available, installed, compatible or incompatible packages |
| postinstall  | display postinstall messages of package(s) |
| prop         | display all package boolean properties |
| reinstall    | remove and install package(s) |
| remove       | remove package(s) |
| search       | look for package(s) |
| sysinfo      | show system information in markdown style |
| test         | test crew command(s) |
| update       | update crew itself |
| upgrade      | update all or specific package(s) |
| upload       | upload binaries for all or specific package(s) |
| whatprovides | regex search for package(s) that contains file(s) |

Available packages are listed in the [packages directory](https://github.com/chromebrew/chromebrew/tree/master/packages).

Chromebrew will wipe its `BREW_DIR` (`/usr/local/tmp/crew` by default) after installation unless you pass `-k` or `--keep` when running `crew install`.

```text
crew install --keep [...]
```

## License

Copyright 2013-2024 Michal Siwek and [all the awesome contributors](https://github.com/chromebrew/chromebrew/graphs/contributors).

This project including all of its source files is released under the terms of [GNU General Public License (version 3 or later)](http://www.gnu.org/licenses/gpl.txt). This project embeds [docopt.rb](https://github.com/docopt/docopt.rb) at lib/docopt.rb. We retain its [MIT license](lib/docopt.LICENSE).

<div>
  <a rel="license-software" href="https://www.gnu.org/licenses/gpl-3.0.en.html"><img alt="GNU General Public License" src="https://www.gnu.org/graphics/gplv3-127x51.png" height="31" /></a>
  <img src="about:blank" width="15px"> <!-- acting a space between two images -->
  <a rel="license-docopt" href="https://mit-license.org/"><img alt="MIT License" src="https://upload.wikimedia.org/wikipedia/commons/0/0c/MIT_logo.svg" height="31" /></a>
</div>