{"id":13850453,"url":"https://github.com/davidosomething/dotfiles","last_synced_at":"2025-07-12T22:30:38.058Z","repository":{"id":2655870,"uuid":"3646562","full_name":"davidosomething/dotfiles","owner":"davidosomething","description":"mac OS, Arch Linux, and Debian/Ubuntu + Neovim","archived":false,"fork":false,"pushed_at":"2024-11-15T16:32:45.000Z","size":27830,"stargazers_count":340,"open_issues_count":14,"forks_count":21,"subscribers_count":6,"default_branch":"dev","last_synced_at":"2024-11-15T17:32:27.445Z","etag":null,"topics":["bash","dotfiles","fzf","git","hammerspoon","neovim","shell","tmux","vim","xdg","zsh"],"latest_commit_sha":null,"homepage":"https://github.com/davidosomething/dotfiles","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/davidosomething.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["davidosomething"]}},"created_at":"2012-03-07T06:45:57.000Z","updated_at":"2024-11-15T16:32:49.000Z","dependencies_parsed_at":"2023-12-19T07:23:13.015Z","dependency_job_id":"1714df79-46e3-479c-8ef3-ea23cc68c0ed","html_url":"https://github.com/davidosomething/dotfiles","commit_stats":{"total_commits":6215,"total_committers":21,"mean_commits":"295.95238095238096","dds":0.4551890587288817,"last_synced_commit":"19e65f527857e8e6b9bb45ef1f3bc1e7a3697b69"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidosomething%2Fdotfiles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidosomething%2Fdotfiles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidosomething%2Fdotfiles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidosomething%2Fdotfiles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/davidosomething","download_url":"https://codeload.github.com/davidosomething/dotfiles/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225839487,"owners_count":17532305,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","dotfiles","fzf","git","hammerspoon","neovim","shell","tmux","vim","xdg","zsh"],"created_at":"2024-08-04T20:01:12.944Z","updated_at":"2025-07-12T22:30:38.045Z","avatar_url":"https://github.com/davidosomething.png","language":"Lua","readme":"\u003cimg alt=\"dotfiles\" width=\"200\" src=\"https://cdn.rawgit.com/davidosomething/dotfiles/master/meta/dotfiles-logo.png\"\u003e\n\nMy dotfiles. \u003chttps://github.com/davidosomething/dotfiles\u003e  \nMy [/uses] post may be of interest to you!\n\n![terminal screenshot][screenshot]\n\n\u003e Screenshot of my Zsh prompt\n\n| Tool              | Link                             |\n| ----------------- | -------------------------------- |\n| OS support        | Arch, macOS, Debian, Ubuntu      |\n| Terminal emulator | [WezTerm](./wezterm/wezterm.lua) |\n| Font              | [Maple Mono]                     |\n| Shell             | [Zsh](./zsh/dot.zshrc)           |\n| Shell plugins     | [Zinit](./zsh/zinit.zsh)         |\n| Editor            | [Neovim](./nvim/README.md)       |\n| Tooling/env       | [mise]                           |\n\n- [XDG] compliance wherever possible to keep `$HOME` clean\n  - See [Arch Linux wiki for XDG Base Directory Support]\n  - See [Debian DotFilesList]\n  - See [grawity's notes] and [environ notes]\n- RC files for Lua, markdownlint, node, PHP, python, R, and others\n\n## Installation\n\nSee macOS specific notes in [mac/README.md](./mac/README.md)\n\nGenerally:\n\n```sh\ngit clone https://github.com/davidosomething/dotfiles ~/.dotfiles\n```\n\nThen, run the [bootstrap/symlink](./bootstrap/symlink) script.\n\nAfter symlinking, **restart the shell**. Aliases will be available.\nThe `sshkeygen` alias will help in generating a new SSH key.\n\nRun [bootstrap/cleanup](./bootstrap/cleanup) to clean up stray dotfiles, moving\ninto their XDG Base Directory supported directories and deleting unnecessary\nthings (with confirmation).\n\n## Updating\n\n`u` is an alias to [dot](./bin/dot). Use `u` without arguments for usage.\n\n## Notes\n\n- `bin/`\n  - There's a [readme](./bin/README.md) in `bin/` describing each\n    script/binary. This directory is in the `$PATH`.\n- `git/`\n  - The comment character is `#` instead of `;` so I can use Markdown\n    in my commit messages without trimming the headers as comments. This is\n    also reflected in a custom Vim highlighting syntax\n- `local/`\n  - Unversioned folder, put `zshrc`, `bashrc`, `npmrc`, and `gitconfig` here\n    and they will be automatically sourced, LAST, by the default scripts. _No\n    dots on the filenames._\n- `nvim/`\n  - See [nvim/README.md](./nvim/README.md) for more information.\n- `python/`\n  - Never `sudo pip`. Set up a python virtual environment.\n\n### rc script source order\n\nIf you have node installed, the [dkosourced](./bin/dkosourced) command will show\nyou (not exhaustively) the order scripts get sourced. Without node `echo\n$DKO_SOURCE` works.\n\nFor X apps (no terminal) the value may be:\n\n```text\n/etc/profile\n.xprofile\n  shell/vars\n    shell/xdg\n```\n\n## Shell script code style\n\n- **Script architecture**\n  - Use the `#!/usr/bin/env bash` shebang and write with bash compatibility\n  - Create a private main function with the same name as the shell script.\n    E.g. for a script called `fun`, there should be a `__fun()` that gets\n    called with the original arguments `__fun $@`\n  - Two space indents\n  - Prefer `.` over `source`\n- **Function names**\n  - For private functions in a script, use two underscores `__private_func()`\n    These function names are safe to reuse after running the script once. When\n    namespaced, they are in the form of `__dko_function_name()`.\n- **Function bodies**\n  - Never use the `fn() ( subshell body in parentheses )` format, always use\n    curly braces first for consistency: `fn() { ( subshell body ); }`.\n- **Variable interpolation**\n  - Always use curly braces around the variable name when interpolating in\n    double quotes.\n- **Variable names**\n  - Stick to nouns, lower camel case\n- **Variable scope**\n  - Use `local` and `readonly` variables as much as possible over\n    global/shell-scoped variables.\n- **Comparison**\n  - Not strict on POSIX (e.g. assume my interactive shells are at least BASH)\n  - Do NOT use BASH arrays, use Zsh or Python if need something complicated\n  - Use BASH `==` for string comparison\n  - Use BASH `(( A == 2 ))` for integer comparison (note not `$A`, `$` not\n    needed)\n\n## Credits\n\n\u003e _Logo from [jglovier/dotfiles-logo]_\n\n[Arch Linux wiki for XDG Base Directory Support]: https://wiki.archlinux.org/index.php/XDG_Base_Directory_support\n[Debian DotFilesList]: https://wiki.debian.org/DotFilesList\n[environ notes]: https://github.com/grawity/dotfiles/blob/master/.environ.notes\n[grawity's notes]: https://github.com/grawity/dotfiles/blob/master/.dotfiles.notes\n[jglovier/dotfiles-logo]: https://github.com/jglovier/dotfiles-logo\n[mise]: https://github.com/jdx/mise\n[screenshot]: https://raw.githubusercontent.com/davidosomething/dotfiles/meta/meta/terminal-potatosff.png\n[/uses]: https://www.davidosomething.com/uses/\n[XDG]: https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html\n[Maple Mono]: https://github.com/subframe7536/maple-font\n","funding_links":["https://github.com/sponsors/davidosomething"],"categories":["Vim Script","Lua"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidosomething%2Fdotfiles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavidosomething%2Fdotfiles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidosomething%2Fdotfiles/lists"}