Git Product home page Git Product logo

dotfiles's Introduction

dotfiles that work without sudo

This is a modern Neovim, Tmux, Zsh configuration that supports installing everything locally (i.e. non-system-wide user install, not using sudo).
You can enjoy working on a remote SSH server without root permission, just like you do locally.

image

image

image

Keep it stable!

This repository includes a GitHub Actions that automatically checks if the commit hasn't been made for 1 week.
If it has not been updated for 1 week, we consider that commit to be 'stable' and automatically bump version with stable tag.
In order to try the stable version, just run dotstable after setting up the zsh. This will also pull neovim plugin versions that have been used for the stable commit.

Also, it has many versions of vim configurations.

  • vi to run a fully-featured bleeding-edge configuration of neovim.
  • vic to run neovim with stable and mild configuration using CoC. It's a balance between the two, and should be used when the first option is broken.
  • lazyvim to run pre-configured LazyVim.
  • \vi to run original vim with no plugins (only simple .vimrc)
  • Use vscode_init.lua for VSCode-Neovim.

Features

Zsh

  • Feature-rich prompt powered by Starship
  • Autocomplete, autosuggest
  • Syntax highlighting
  • Vim mode
  • Fuzzy searching with fzf
    • Try Ctrl+t to find file, Alt+c to change directory, Ctrl+r to reverse search commands.
  • Smart change directory with Zoxide
    • Try z <partial dirname..> like z dot will go to the ~/.config/dotfiles.

Neovim

  • Yank registers synchronised with tmux. Yank from neovim and paste on tmux. Copy from tmux and paste on neovim.
  • See more in nvim/README.md

Tmux

Requirements

  • Linux x86-64, Windows WSL2 (Mac support planned. You just need dependency install script to use brew)
  • Neovim v0.9.4 (make sure you use this exact version)
  • Tmux v3.3a
  • Zsh v5.9 (in v5.8 highlighting will look weird and fzf-tab will remove some lines)

Steps

  1. Install dotfiles
cd ~/.config	# it doesn't have to be here. Just install anywhere
git clone https://github.com/kiyoon/dotfiles

# WARNING: ./symlink.sh will override existing dotfiles without validation (but will create a backup).
# The old dotfiles will be moved with '~' suffix.
# Use with care if you configured something manually.
cd dotfiles
./symlink.sh
  1. Install zsh, oh-my-zsh
oh-my-zsh/zsh-local-install.sh
oh-my-zsh/apps-local-install.sh
oh-my-zsh/launch-zsh-in-bash.sh
git submodule update --init --remote  # Install and update all zsh plugins

NOTE: some steps like apps-local-install.sh may not work from the first run, because they break with missing dependencies easily.
Kindly try it again after re-opening your terminal, if some error occurs.

Open your terminal again and you'll see you're running zsh.

See oh-my-zsh/README.md for details.

  1. Install neovim and tmux

You need Neovim v0.9.0. The fold column will look ugly in v0.8.x.

On Linux, you can install locally using:

./install-nvim-tmux-locally-linux.sh

This will download the latest appimage for each and extract at ~/.local/bin.

Install neovim dependencies:

nvim/install-linux.sh

Install tmux plugins:

tmux/install-plugins.sh
  1. Install others
# You might want to symlink dotfiles again in case some scripts overrode them
./symlink.sh
# You only need to install it to the local computer, not in SSH host computer.
./install-nerdfont.sh
# If you're using wezterm (recommended), install terminfo
wezterm/terminfo.sh
  1. Install / Update dotfiles, apps, plugins etc.
# WARNING: This includes calling ./symlink.sh so the dotfile symlinks will be updated.
dotupdate			# Use if you want to update to the latest commit
dotstable			# Use if you want to use the stable tag
dotupdate <tag>		# Specify the tag/commit you want to use

dotfiles's People

Contributors

kiyoon avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.