chore: Updated README
2e6dd3b9
1 file(s) · +71 −64
| 12 | 12 | ||
| 13 | 13 | At the moment this setup and installation flow is designed for MacOS and [Homebrew](https://brew.sh), but by all means feel free to help support the project by creating scripts for Linux or Windows! |
|
| 14 | 14 | ||
| 15 | + | ## Features |
|
| 16 | + | ||
| 17 | + | Thanks to the programs installed you will have several nice quality of life features available in your terminal! |
|
| 18 | + | ||
| 19 | + | ### AI Shell |
|
| 20 | + | ||
| 21 | + | Through [AIChat](https://github.com/sigoden/aichat) you can have a great AI experience in your terminal. Start by running the command `ai` which will create a config and ask for your preferred provider and API key if applicable. If you want to use a local model with a tool like `ollama` use the `openai-compatible` option and use `http://localhost:11434/v1` as the base URL with no API key. |
|
| 22 | + | ||
| 23 | + |  |
|
| 24 | + | ||
| 25 | + | Once installed you can use AI in multiple ways in your terminal. |
|
| 26 | + | ||
| 27 | + | Start an AI chat session, or do a single prompt |
|
| 28 | + | ||
| 29 | + | ```bash |
|
| 30 | + | ai |
|
| 31 | + | ||
| 32 | + | ai why is the sky blue? |
|
| 33 | + | ``` |
|
| 34 | + | ||
| 35 | + | Have AI generate a shell command |
|
| 36 | + | ||
| 37 | + | ```bash |
|
| 38 | + | ai -e find my current IP address |
|
| 39 | + | ``` |
|
| 40 | + | ||
| 41 | + | Generate just code |
|
| 42 | + | ||
| 43 | + | ```bash |
|
| 44 | + | ai -c React useEffect hook usage |
|
| 45 | + | ``` |
|
| 46 | + | ||
| 47 | + | Feed it a file as context |
|
| 48 | + | ||
| 49 | + | ```bash |
|
| 50 | + | ai -f src/index.ts explain this code |
|
| 51 | + | ``` |
|
| 52 | + | ||
| 53 | + | AIChat has a lot more capabilities we can't cover here, so by all means [check out the docs](https://github.com/sigoden/aichat/wiki/Chat-REPL-Guide) for more info! |
|
| 54 | + | ||
| 55 | + | ### Better `zsh` |
|
| 56 | + | ||
| 57 | + | By installing `zsh-autosuggestions` and `zsh-syntax-highlighting` we're able to get a much better auto complete setup with zero zsh frameworks or package managers! |
|
| 58 | + | ||
| 59 | + |  |
|
| 60 | + | ||
| 61 | + | ### Better `cd` with `zoxide` |
|
| 62 | + | ||
| 63 | + | As you use `cd` to move into different directories, zoxide will gain memory of where you've been and make it easier to navigate to it later. For example, if you used `cd ~/Desktop`, anytime after that you can just use `cd Desktop` to navigate directly to that folder, without needing the full path. You can also use partial words like `cd Desk`. |
|
| 64 | + | ||
| 65 | + |  |
|
| 66 | + | ||
| 67 | + | ### Better `ls` with `eza` |
|
| 68 | + | ||
| 69 | + | `eza` provides a more visually appealing `ls` command that uses NerdFont icons from the patched [CommitMono](https://commitmono.com) font installed with your setup. |
|
| 70 | + | ||
| 71 | + |  |
|
| 72 | + | ||
| 73 | + | ### Better `htop` with `btop` |
|
| 74 | + | ||
| 75 | + | Nothing is more satisfying than viewing your system processes, and there's not a better way to do that than with [`btop`](https://github.com/aristocratos/btop). For best color results, update the theme to `TTY` by hitting `ESC` then going to `Settings`. |
|
| 76 | + | ||
| 77 | + |  |
|
| 78 | + | ||
| 15 | 79 | ## Installation |
|
| 16 | 80 | ||
| 17 | 81 | > [!NOTE] |
|
| 152 | 216 | ||
| 153 | 217 | After following these steps you should be able to open Ghostty and you will have the DARKMATTER setup |
|
| 154 | 218 | ||
| 155 | - | ## Features |
|
| 156 | - | ||
| 157 | - | Thanks to the programs installed you will have several nice quality of life features available in your terminal! |
|
| 158 | - | ||
| 159 | - | ### AI Shell |
|
| 160 | - | ||
| 161 | - | Through [AIChat](https://github.com/sigoden/aichat) you can have a great AI experience in your terminal. Start by running the command `ai` which will create a config and ask for your preferred provider and API key if applicable. If you want to use a local model with a tool like `ollama` use the `openai-compatible` option and use `http://localhost:11434/v1` as the base URL with no API key. |
|
| 162 | - | ||
| 163 | - |  |
|
| 164 | - | ||
| 165 | - | Once installed you can use AI in multiple ways in your terminal. |
|
| 166 | - | ||
| 167 | - | Start an AI chat session, or do a single prompt |
|
| 168 | - | ||
| 169 | - | ```bash |
|
| 170 | - | ai |
|
| 171 | - | ||
| 172 | - | ai why is the sky blue? |
|
| 173 | - | ``` |
|
| 174 | - | ||
| 175 | - | Have AI generate a shell command |
|
| 176 | - | ||
| 177 | - | ```bash |
|
| 178 | - | ai -e find my current IP address |
|
| 179 | - | ``` |
|
| 180 | - | ||
| 181 | - | Generate just code |
|
| 182 | - | ||
| 183 | - | ```bash |
|
| 184 | - | ai -c React useEffect hook usage |
|
| 185 | - | ``` |
|
| 186 | - | ||
| 187 | - | Feed it a file as context |
|
| 188 | - | ||
| 189 | - | ```bash |
|
| 190 | - | ai -f src/index.ts explain this code |
|
| 191 | - | ``` |
|
| 192 | - | ||
| 193 | - | AIChat has a lot more capabilities we can't cover here, so by all means [check out the docs](https://github.com/sigoden/aichat/wiki/Chat-REPL-Guide) for more info! |
|
| 194 | - | ||
| 195 | - | ### Better `zsh` |
|
| 196 | - | ||
| 197 | - | By installing `zsh-autosuggestions` and `zsh-syntax-highlighting` we're able to get a much better auto complete setup with zero zsh frameworks or package managers! |
|
| 198 | - | ||
| 199 | - |  |
|
| 200 | - | ||
| 201 | - | ### Better `cd` with `zoxide` |
|
| 202 | - | ||
| 203 | - | As you use `cd` to move into different directories, zoxide will gain memory of where you've been and make it easier to navigate to it later. For example, if you used `cd ~/Desktop`, anytime after that you can just use `cd Desktop` to navigate directly to that folder, without needing the full path. You can also use partial words like `cd Desk`. |
|
| 204 | - | ||
| 205 | - |  |
|
| 206 | - | ||
| 207 | - | ### Better `ls` with `eza` |
|
| 208 | - | ||
| 209 | - | `eza` provides a more visually appealing `ls` command that uses NerdFont icons from the patched [CommitMono](https://commitmono.com) font installed with your setup. |
|
| 210 | - | ||
| 211 | - |  |
|
| 212 | - | ||
| 213 | - | ### Better `htop` with `btop` |
|
| 214 | - | ||
| 215 | - | Nothing is more satisfying than viewing your system processes, and there's not a better way to do that than with [`btop`](https://github.com/aristocratos/btop). For best color results, update the theme to `TTY` by hitting `ESC` then going to `Settings`. |
|
| 216 | - | ||
| 217 | - |  |
|
| 218 | - | ||
| 219 | 219 | ## Themes |
|
| 220 | 220 | ||
| 221 | 221 | DARKMATTER comes with it's own custom theme that I modeled after my favorite theme of all time, Black Metal Bathory. Thankfully Ghostty comes with hundreds of themes you can choose from; just run the following command to see them all! |
|
| 243 | 243 | ||
| 244 | 244 | > [!NOTE] |
|
| 245 | 245 | > For more info on customizing your prompt [check out the docs](https://starship.rs) |
|
| 246 | + | ||
| 247 | + | ## Ports |
|
| 248 | + | ||
| 249 | + | Darkmatter is a theme I'm slowly building out into other ports, check them out here! |
|
| 250 | + | ||
| 251 | + | - [Zed](https://github.com/stevedylandev/darkmatter-zed) |
|
| 252 | + | - [Neovim](https://github.com/stevedylandev/darkmatter-nvim) |
|
| 246 | 253 | ||
| 247 | 254 | ## Questions |
|
| 248 | 255 | ||