https://github.com/shikr/dotfiles
My config files
https://github.com/shikr/dotfiles
kitty linux neovim nvim rofi shell starship starship-prompt terminal zsh
Last synced: 3 months ago
JSON representation
My config files
- Host: GitHub
- URL: https://github.com/shikr/dotfiles
- Owner: shikr
- License: gpl-3.0
- Created: 2023-07-02T23:59:47.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-02-05T17:55:54.000Z (over 1 year ago)
- Last Synced: 2025-02-05T18:56:00.262Z (over 1 year ago)
- Topics: kitty, linux, neovim, nvim, rofi, shell, starship, starship-prompt, terminal, zsh
- Language: Lua
- Homepage:
- Size: 3.22 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Dotfiles
## Details
- **Compositor**: [niri](https://github.com/YaLTeR/niri)
- **Bar**: [ags](https://github.com/Aylur/ags)
- **Terminal**: [kitty](https://github.com/kovidgoyal/kitty/)
- **Shell**: [zsh](https://www.zsh.org/)
- **Editor**: [neovim](https://github.com/neovim/neovim)
- **File Manager**: [superfile](https://github.com/yorukot/superfile)
- **Application Launcher**: [rofi](https://github.com/davatorium/rofi)
- **Music Player**: [spotify-player](https://github.com/aome510/spotify-player)
- **Font**: [FiraCode NerdFont](https://www.nerdfonts.com/font-downloads)
## Setup
### Required Dependencies
- [WirePlumber](https://pipewire.pages.freedesktop.org/wireplumber/) and [Playerctl](https://github.com/altdesktop/playerctl) for niri.
- [astal](https://aylur.github.io/astal/), [esbuild](https://esbuild.github.io/) and [accountsservice](https://gitlab.freedesktop.org/accountsservice/accountsservice) for ags.
- [FiraCode NerdFont](https://www.nerdfonts.com/font-downloads), [Inter Font](https://rsms.me/inter/) and [Symbols NerdFont](https://www.nerdfonts.com/font-downloads) for kitty and rofi.
- [ripgrep](https://github.com/BurntSushi/ripgrep#installation), [Node.js](https://nodejs.org/es/download), [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/) and [Rust](https://www.rust-lang.org/tools/install) for neovim.
- [exiftool](https://exiftool.org/) for superfile.
- [oh my zsh](https://ohmyz.sh/) and [fzf](https://github.com/junegunn/fzf) for zsh.
> Clone this repository
```sh
git clone https://github.com/shikr/dotfiles.git
cd dotfiles
```
> Run installation script
Using npx
```sh
./install.mjs
```
Or with [pnpm](https://pnpm.io/)
```sh
pnpm install
pnpm start
```
### Customize your installation
Usage: `./install.mjs [OPTIONS] [...CONFIGS]`
```
Options:
-p, --zsh-plugins Install zsh plugins. (default: true)
-S, --symlink Create symlinks instead of copying files. (default: true)
-b, --backup Backup existing files. (default: true)
-I, --install Install all configurations. If disabled, the script will only do a dry run. (default: true)
-B, --scripts Install provided scripts. (default: true)
-i, --ignore Ignore configurations. (-i zsh,rofi)
CONFIGS: zsh, niri, kitty, rofi, spotify_player, nvim, superfile, ags, starship
-s, --silent Suppress output.
-h, --help Show this help message.
```
## Credits
- [Rofi Theme](https://github.com/adi1090x/rofi)
- [Rofi Background Image](https://www.pixiv.net/artworks/60839445)