{"id":20011219,"url":"https://github.com/qqphp/ohmyzsh","last_synced_at":"2026-05-12T10:34:39.558Z","repository":{"id":166676848,"uuid":"285560844","full_name":"qqphp/ohmyzsh","owner":"qqphp","description":null,"archived":false,"fork":false,"pushed_at":"2020-08-06T12:06:59.000Z","size":768,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-12T14:47:35.181Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qqphp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","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}},"created_at":"2020-08-06T12:04:54.000Z","updated_at":"2020-08-06T12:07:03.000Z","dependencies_parsed_at":"2023-06-01T15:00:18.037Z","dependency_job_id":null,"html_url":"https://github.com/qqphp/ohmyzsh","commit_stats":null,"previous_names":["qqphp/ohmyzsh"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qqphp%2Fohmyzsh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qqphp%2Fohmyzsh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qqphp%2Fohmyzsh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qqphp%2Fohmyzsh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qqphp","download_url":"https://codeload.github.com/qqphp/ohmyzsh/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241447644,"owners_count":19964336,"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":[],"created_at":"2024-11-13T07:24:49.677Z","updated_at":"2026-05-12T10:34:34.536Z","avatar_url":"https://github.com/qqphp.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://s3.amazonaws.com/ohmyzsh/oh-my-zsh-logo.png\" alt=\"Oh My Zsh\"\u003e\n\u003c/p\u003e\n\nOh My Zsh is an open source, community-driven framework for managing your [zsh](https://www.zsh.org/) configuration.\n\nSounds boring. Let's try again.\n\n__Oh My Zsh will not make you a 10x developer...but you may feel like one.__\n\nOnce installed, your terminal shell will become the talk of the town _or your money back!_ With each keystroke in your command prompt, you'll take advantage of the hundreds of powerful plugins and beautiful themes. Strangers will come up to you in cafés and ask you, _\"that is amazing! are you some sort of genius?\"_\n\nFinally, you'll begin to get the sort of attention that you have always felt you deserved. ...or maybe you'll use the time that you're saving to start flossing more often. 😬\n\nTo learn more, visit [ohmyz.sh](https://ohmyz.sh), follow [@ohmyzsh](https://twitter.com/ohmyzsh) on Twitter, and/or join us on [Discord](https://discord.gg/ohmyzsh).\n\n[![CI](https://github.com/ohmyzsh/ohmyzsh/workflows/CI/badge.svg)](https://github.com/ohmyzsh/ohmyzsh/actions?query=workflow%3ACI)\n[![Follow @ohmyzsh](https://img.shields.io/twitter/follow/ohmyzsh?label=Follow+@ohmyzsh\u0026style=flat)](https://twitter.com/intent/follow?screen_name=ohmyzsh)\n[![Discord server](https://img.shields.io/discord/642496866407284746)](https://discord.gg/ohmyzsh)\n\n## Getting Started\n\n### Prerequisites\n\n* A Unix-like operating system: macOS, Linux, BSD. On Windows: WSL2 is preferred, but cygwin or msys also mostly work.\n* [Zsh](https://www.zsh.org) should be installed (v4.3.9 or more recent is fine but we prefer 5.0.8 and newer). If not pre-installed (run `zsh --version` to confirm), check the following wiki instructions here: [Installing ZSH](https://github.com/ohmyzsh/ohmyzsh/wiki/Installing-ZSH)\n* `curl` or `wget` should be installed\n* `git` should be installed (recommended v2.4.11 or higher)\n\n### Basic Installation\n\nOh My Zsh is installed by running one of the following commands in your terminal. You can install this via the command-line with either `curl` or `wget`, whichever is installed on your machine.\n\n#### via curl\n\n```shell\nsh -c \"$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)\"\n```\n\n#### via wget\n\n```shell\nsh -c \"$(wget -O- https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)\"\n```\n\n#### Manual inspection\n\nIt's a good idea to inspect the install script from projects you don't yet know. You can do\nthat by downloading the install script first, looking through it so everything looks normal,\nthen running it:\n\n```shell\ncurl -Lo install.sh https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh\nsh install.sh\n```\n\n## Using Oh My Zsh\n\n### Plugins\n\nOh My Zsh comes with a shitload of plugins for you to take advantage of. You can take a look in the [plugins](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins) directory and/or the [wiki](https://github.com/ohmyzsh/ohmyzsh/wiki/Plugins) to see what's currently available.\n\n#### Enabling Plugins\n\nOnce you spot a plugin (or several) that you'd like to use with Oh My Zsh, you'll need to enable them in the `.zshrc` file. You'll find the zshrc file in your `$HOME` directory. Open it with your favorite text editor and you'll see a spot to list all the plugins you want to load.\n\n```shell\nvi ~/.zshrc\n```\n\nFor example, this might begin to look like this:\n\n```shell\nplugins=(\n  git\n  bundler\n  dotenv\n  osx\n  rake\n  rbenv\n  ruby\n)\n```\n\n_Note that the plugins are separated by whitespace (spaces, tabs, new lines...). **Do not** use commas between them or it will break._\n\n#### Using Plugins\n\nEach plugin includes a __README__, documenting it. This README should show the aliases (if the plugin adds any) and extra goodies that are inclued in that particular plugin.\n\n### Themes\n\nWe'll admit it. Early in the Oh My Zsh world, we may have gotten a bit too theme happy. We have over one hundred and fifty themes now bundled. Most of them have [screenshots](https://github.com/ohmyzsh/ohmyzsh/wiki/Themes) on the wiki (We are working on updating this!). Check them out!\n\n#### Selecting a Theme\n\n_Robby's theme is the default one. It's not the fanciest one. It's not the simplest one. It's just the right one (for him)._\n\nOnce you find a theme that you'd like to use, you will need to edit the `~/.zshrc` file. You'll see an environment variable (all caps) in there that looks like:\n\n```shell\nZSH_THEME=\"robbyrussell\"\n```\n\nTo use a different theme, simply change the value to match the name of your desired theme. For example:\n\n```shell\nZSH_THEME=\"agnoster\" # (this is one of the fancy ones)\n# see https://github.com/ohmyzsh/ohmyzsh/wiki/Themes#agnoster\n```\n\n_Note: many themes require installing the [Powerline Fonts](https://github.com/powerline/fonts) in order to render properly._\n\nOpen up a new terminal window and your prompt should look something like this:\n\n![Agnoster theme](https://cloud.githubusercontent.com/assets/2618447/6316862/70f58fb6-ba03-11e4-82c9-c083bf9a6574.png)\n\nIn case you did not find a suitable theme for your needs, please have a look at the wiki for [more of them](https://github.com/ohmyzsh/ohmyzsh/wiki/External-themes).\n\nIf you're feeling feisty, you can let the computer select one randomly for you each time you open a new terminal window.\n\n\n```shell\nZSH_THEME=\"random\" # (...please let it be pie... please be some pie..)\n```\n\nAnd if you want to pick random theme from a list of your favorite themes:\n\n```shell\nZSH_THEME_RANDOM_CANDIDATES=(\n  \"robbyrussell\"\n  \"agnoster\"\n)\n```\n\nIf you only know which themes you don't like, you can add them similarly to a blacklist:\n\n```shell\nZSH_THEME_RANDOM_BLACKLIST=(pygmalion tjkirch_mod)\n```\n\n### FAQ\n\nIf you have some more questions or issues, you might find a solution in our [FAQ](https://github.com/ohmyzsh/ohmyzsh/wiki/FAQ).\n\n## Advanced Topics\n\nIf you're the type that likes to get their hands dirty, these sections might resonate.\n\n### Advanced Installation\n\nSome users may want to manually install Oh My Zsh, or change the default path or other settings that\nthe installer accepts (these settings are also documented at the top of the install script).\n\n#### Custom Directory\n\nThe default location is `~/.oh-my-zsh` (hidden in your home directory, you can access it with `cd ~/.oh-my-zsh`)\n\nIf you'd like to change the install directory with the `ZSH` environment variable, either by running\n`export ZSH=/your/path` before installing, or by setting it before the end of the install pipeline\nlike this:\n\n```shell\nZSH=\"$HOME/.dotfiles/oh-my-zsh\" sh install.sh\n```\n\n#### Unattended install\n\nIf you're running the Oh My Zsh install script as part of an automated install, you can pass the\nflag `--unattended` to the `install.sh` script. This will have the effect of not trying to change\nthe default shell, and also won't run `zsh` when the installation has finished.\n\n```shell\nsh -c \"$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)\" \"\" --unattended\n```\n\n#### Installing from a forked repository\n\nThe install script also accepts these variables to allow installation of a different repository:\n\n- `REPO` (default: `ohmyzsh/ohmyzsh`): this takes the form of `owner/repository`. If you set\n  this variable, the installer will look for a repository at `https://github.com/{owner}/{repository}`.\n\n- `REMOTE` (default: `https://github.com/${REPO}.git`): this is the full URL of the git repository\n  clone. You can use this setting if you want to install from a fork that is not on GitHub (GitLab,\n  Bitbucket...) or if you want to clone with SSH instead of HTTPS (`git@github.com:user/project.git`).\n\n  _NOTE: it's incompatible with setting the `REPO` variable. This setting will take precedence._\n\n- `BRANCH` (default: `master`): you can use this setting if you want to change the default branch to be\n  checked out when cloning the repository. This might be useful for testing a Pull Request, or if you\n  want to use a branch other than `master`.\n\nFor example:\n\n```shell\nREPO=apjanke/oh-my-zsh BRANCH=edge sh install.sh\n```\n\n#### Manual Installation\n\n##### 1. Clone the repository:\n\n```shell\ngit clone https://github.com/ohmyzsh/ohmyzsh.git ~/.oh-my-zsh\n```\n\n##### 2. *Optionally*, backup your existing `~/.zshrc` file:\n\n```shell\ncp ~/.zshrc ~/.zshrc.orig\n```\n\n##### 3. Create a new zsh configuration file\n\nYou can create a new zsh config file by copying the template that we have included for you.\n\n```shell\ncp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc\n```\n\n##### 4. Change your default shell\n\n```shell\nchsh -s $(which zsh)\n```\n\nYou must log out from your user session and log back in to see this change.\n\n##### 5. Initialize your new zsh configuration\n\nOnce you open up a new terminal window, it should load zsh with Oh My Zsh's configuration.\n\n### Installation Problems\n\nIf you have any hiccups installing, here are a few common fixes.\n\n* You _might_ need to modify your `PATH` in `~/.zshrc` if you're not able to find some commands after\nswitching to `oh-my-zsh`.\n* If you installed manually or changed the install location, check the `ZSH` environment variable in\n`~/.zshrc`.\n\n### Custom Plugins and Themes\n\nIf you want to override any of the default behaviors, just add a new file (ending in `.zsh`) in the `custom/` directory.\n\nIf you have many functions that go well together, you can put them as a `XYZ.plugin.zsh` file in the `custom/plugins/` directory and then enable this plugin.\n\nIf you would like to override the functionality of a plugin distributed with Oh My Zsh, create a plugin of the same name in the `custom/plugins/` directory and it will be loaded instead of the one in `plugins/`.\n\n## Getting Updates\n\nBy default, you will be prompted to check for upgrades every few weeks. If you would like `oh-my-zsh` to automatically upgrade itself without prompting you, set the following in your `~/.zshrc`:\n\n```shell\nDISABLE_UPDATE_PROMPT=true\n```\n\nTo disable automatic upgrades, set the following in your `~/.zshrc`:\n\n```shell\nDISABLE_AUTO_UPDATE=true\n```\n\n### Manual Updates\n\nIf you'd like to upgrade at any point in time (maybe someone just released a new plugin and you don't want to wait a week?) you just need to run:\n\n```shell\nupgrade_oh_my_zsh\n```\n\nMagic! 🎉\n\n## Uninstalling Oh My Zsh\n\nOh My Zsh isn't for everyone. We'll miss you, but we want to make this an easy breakup.\n\nIf you want to uninstall `oh-my-zsh`, just run `uninstall_oh_my_zsh` from the command-line. It will remove itself and revert your previous `bash` or `zsh` configuration.\n\n## How do I contribute to Oh My Zsh?\n\nBefore you participate in our delightful community, please read the [code of conduct](CODE_OF_CONDUCT.md).\n\nI'm far from being a [Zsh](https://www.zsh.org/) expert and suspect there are many ways to improve – if you have ideas on how to make the configuration easier to maintain (and faster), don't hesitate to fork and send pull requests!\n\nWe also need people to test out pull-requests. So take a look through [the open issues](https://github.com/ohmyzsh/ohmyzsh/issues) and help where you can.\n\nSee [Contributing](CONTRIBUTING.md) for more details.\n\n### Do NOT send us themes\n\nWe have (more than) enough themes for the time being. Please add your theme to the [external themes](https://github.com/ohmyzsh/ohmyzsh/wiki/External-themes) wiki page.\n\n## Contributors\n\nOh My Zsh has a vibrant community of happy users and delightful contributors. Without all the time and help from our contributors, it wouldn't be so awesome.\n\nThank you so much!\n\n## Follow Us\n\nWe're on the social media.\n\n* [@ohmyzsh](https://twitter.com/ohmyzsh) on Twitter. You should follow it.\n* [FaceBook](https://www.facebook.com/Oh-My-Zsh-296616263819290/) poke us.\n* [Instagram](https://www.instagram.com/_ohmyzsh/) tag us in your post showing Oh My Zsh!\n* [Discord](https://discord.gg/ohmyzsh) to chat with us!\n\n## Merchandise\n\nWe have [stickers, shirts, and coffee mugs available](https://shop.planetargon.com/collections/oh-my-zsh?utm_source=github) for you to show off your love of Oh My Zsh. Again, you will become the talk of the town!\n\n## License\n\nOh My Zsh is released under the [MIT license](LICENSE.txt).\n\n## About Planet Argon\n\n![Planet Argon](https://pa-github-assets.s3.amazonaws.com/PARGON_logo_digital_COL-small.jpg)\n\nOh My Zsh was started by the team at [Planet Argon](https://www.planetargon.com/?utm_source=github), a [Ruby on Rails development agency](https://www.planetargon.com/skills/ruby-on-rails-development?utm_source=github). Check out our [other open source projects](https://www.planetargon.com/open-source?utm_source=github).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqqphp%2Fohmyzsh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqqphp%2Fohmyzsh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqqphp%2Fohmyzsh/lists"}