Skip to content
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.

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

Zsh rebased #61

Open
wants to merge 16 commits into
base: master
Choose a base branch
from
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

improving the dev workflow friction is paramount to innovating [openpilot](https://github.com/commaai/openpilot)

***PRs accepted!** What cool shit do you do to your ssh session with your car??*
**\*PRs accepted!** What cool shit do you do to your ssh session with your car??\*

This tool was created by [Alice Knag](https://github.com/AskAlice) - `@emu#6969` on Discord, and is widely contributed to by [ShaneSmiskol](https://github.com/sshane) - `Shane#6175`
If you have any questions about the development process, or have any ideas you want to see happen, check out [CONTRIBUTING.md](CONTRIBUTING.md) and/or DM one of us on Discord or ask in #custom-forks

<p align="center">
<img src="https://emu.bz/bh8" alt="" />
<a href="https://i.imgur.com/Bbr1sPX.mp4">
Expand All @@ -16,19 +17,20 @@ If you have any questions about the development process, or have any ideas you w
# Getting Started

To install these utilities, SSH into your comma device running neos (ie Comma 2, Eon, etc), and paste in the following:

```bash
bash <(curl -fsSL install.emu.sh) # the brain of the bird
source <(curl -fsSL install.emu.sh) # the brain of the bird
source /data/community/.bashrc
```

<!-- <img src="https://thumbs.gfycat.com/DopeyHairyGeese-size_restricted.gif" alt ="" /> -->

---
Read the README for <https://github.com/b-ryan/powerline-shell>. You can optionally [install the fonts on the computer/terminal emulator that you SSH from](https://github.com/powerline/fonts)

Alternately, you can install [Nerd Fonts](https://github.com/ryanoasis/nerd-fonts), as it provides more icons than powerline fonts, and is more maintained.
The script will optionally install zsh and powerlevel10k
Read the README for <https://github.com/romkatv/powerlevel10k>. You will need to [install the fonts on the computer/terminal emulator that you SSH from](https://www.nerdfonts.com/font-downloads)

Once NEOS 15 comes out, zsh will be used and [powerlevel10k](https://github.com/romkatv/powerlevel10k) will be the optimal powerline
[Nerd Fonts](https://github.com/ryanoasis/nerd-fonts) is recommended if you use zsh+powerlevel10k

The default directory of your bash/ssh session is now `/data/openpilot`. Much easier to git pull after shelling in.

Expand All @@ -52,17 +54,24 @@ This will essentially perform a git pull and replace all current files in the `/
# Commands

### General

- `emu update`: 🎉 Updates this tool, recommended to restart ssh session
- `emu uninstall`: 👋 Uninstalls emu

### [Forks](#fork-management)

- `emu fork`: 🍴 Manage installed forks, or install a new one
- `emu fork switch`: 🍴 Switch between any openpilot fork
- `emu fork list`: 📜 See a list of installed forks and branches

### Panda

- `emu panda`: 🐼 panda interfacing tools
- `emu panda flash`: 🐼 flashes panda with make recover (usually works with the C2)
- `emu panda flash2`: 🎍 flashes panda using Panda module (usually works with the EON)

### Debugging

- `emu debug`: de-🐛-ing tools
- `emu debug controlsd`: 🔬 logs controlsd to /data/output.log by default
- `emu device`: 📈 Statistics about your device
Expand All @@ -76,6 +85,7 @@ To see more information about each command and its arguments, checkout the full
---

# Fork management

When you first run any `emu fork` command, `emu` will ask you to perform a one-time setup of cloning the base repository of openpilot from commaai. This may take a while, but upon finishing the setup you will be able to switch to any openpilot fork much quicker than the time it usually takes to full-clone a new fork the old fashioned way.

For each new fork you install with the `emu fork switch` command, Git is able to re-use blobs already downloaded from commaai/openpilot and other similar installed forks, enabling quicker install times. For a shorter command, `fork` is automatically aliased to `emu fork switch`.
Expand Down
Loading