{"id":20596275,"url":"https://github.com/ulhpc/dotfiles","last_synced_at":"2025-04-14T23:44:24.051Z","repository":{"id":10637781,"uuid":"12863506","full_name":"ULHPC/dotfiles","owner":"ULHPC","description":"User configuration files","archived":false,"fork":false,"pushed_at":"2024-04-12T13:46:20.000Z","size":141,"stargazers_count":10,"open_issues_count":0,"forks_count":3,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-14T23:44:19.546Z","etag":null,"topics":["bash","dotfiles","git","screen","ssh","vim"],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ULHPC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing/README.md","funding":null,"license":"LICENSE","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}},"created_at":"2013-09-16T09:32:24.000Z","updated_at":"2024-07-30T12:59:04.000Z","dependencies_parsed_at":"2024-03-11T11:50:47.828Z","dependency_job_id":null,"html_url":"https://github.com/ULHPC/dotfiles","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ULHPC%2Fdotfiles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ULHPC%2Fdotfiles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ULHPC%2Fdotfiles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ULHPC%2Fdotfiles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ULHPC","download_url":"https://codeload.github.com/ULHPC/dotfiles/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248981259,"owners_count":21193143,"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","git","screen","ssh","vim"],"created_at":"2024-11-16T08:16:06.663Z","updated_at":"2025-04-14T23:44:24.033Z","avatar_url":"https://github.com/ULHPC.png","language":"Shell","readme":"-*- mode: markdown; mode: visual-line; fill-column: 80 -*-\n\n[![Licence](https://img.shields.io/badge/license-GPL--3.0-blue.svg)](http://www.gnu.org/licenses/gpl-3.0.html) ![By ULHPC](https://img.shields.io/badge/by-ULHPC-blue.svg)  [![Build Status](https://travis-ci.org/ULHPC/dotfiles.svg?branch=master)](https://travis-ci.org/ULHPC/dotfiles) [![github](https://img.shields.io/badge/git-github- lightgray.svg)](https://github.com/ULHPC/dotfiles) [![ULHPC/dotfiles issues](https://img.shields.io/github/issues/ULHPC/dotfiles.svg)](https://github.com/ULHPC/dotfiles/issues) ![](https://img.shields.io/github/stars/ULHPC/dotfiles.svg) [![Documentation Status](https://readthedocs.org/projects/ulhpc-dotfiles/badge/?version=latest)](https://readthedocs.org/projects/ulhpc-dotfiles/?badge=latest)\n\n      Time-stamp: \u003cMon 2015-05-25 17:20 svarrette\u003e\n       _   _ _     _   _ ____   ____   ____        _    __ _ _\n      | | | | |   | | | |  _ \\ / ___| |  _ \\  ___ | |_ / _(_) | ___  ___\n      | | | | |   | |_| | |_) | |     | | | |/ _ \\| __| |_| | |/ _ \\/ __|\n      | |_| | |___|  _  |  __/| |___  | |_| | (_) | |_|  _| | |  __/\\__ \\\n       \\___/|_____|_| |_|_|    \\____| |____/ \\___/ \\__|_| |_|_|\\___||___/\n\n         Copyright (c) 2013-2016 UL HPC Management Team \u003chpc-sysadmins@uni.lu\u003e\n\n# ULHPC dotfiles (bash, vim, screen etc.) \n\n## Synopsis\n\nThis repository offers a set of default configuration files for `bash`, `screen`, `vim` etc. suitable for the [ULHPC](http://hpc.uni.lu) environment, but also for any Linux user wishing a reasonable set of functionality for these software (better than the default one proposed by default). \nFor instance, this repository is used in the [ULHPC/bash](https://github.com/ULHPC/puppet-bash) puppet module.\n\nIn the sequel, when providing a command, `$\u003e` denotes a prompt and is not part of the commands.\n\n## Pre-requisites\n\nYou should install the following elements to use the full functionality of\nthese configuration files:\n\n* bash\n* bash-completions\n* screen\n* git\n* subversion\n* vim\n\n\n## Installation\n\n### All-in-one git-free install\n\nUsing `curl` (adapt the `--all` option to whatever you prefer -- see below table):\n\n``` bash\n$\u003e curl -fsSL https://raw.githubusercontent.com/ULHPC/dotfiles/master/install.sh | bash -s -- --all\n```\n\n### Using Git and the embedded Makefile\n\nThis repository is hosted on [Github](https://github.com/ULHPC/dotfiles). You can clone the repository wherever you want.\nIf the location of the local repository is not `~/.dotfiles`, the `install.sh` script will create a symlink `~/.dotfiles` pointing to the location of the repository.\n\nTo clone this repository directly into `~/.dotfiles/`, proceed as follows\n\n        $\u003e git clone https://github.com/ULHPC/dotfiles.git ~/.dotfiles\n\n**`/!\\ IMPORTANT`**: Once cloned, initiate your local copy of the repository by running:\n\n        $\u003e cd ~/.dotfiles\n        $\u003e make setup\n\nThis will initiate the Git submodules of this repository and setup the [git flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) layout for this repository.\n\nNow to install all the dotfiles, run:\n\n~~~bash\n    $\u003e make install\n~~~\n\n### Using Git and the embedded `install.sh` script\n\nThe above `make install` command actually runs (see `.Makefile.after`):\n\n~~~bash\n     $\u003e ./install.sh --all   # Equivalent of 'make install'\n~~~\n\nNote that __by default__ (_i.e._ without option), the `install.sh` script does nothing __except__ cloning the repository if the dotfiles directory does not yet exists (in `~/.dotfiles` by default).\n\n* if you __do not want to install everything__ but only a subpart, kindly refer to the below table to find the proper command-line argument to use. Ex:\n\n```bash\n         $\u003e ./install.sh --vim --git\n```\n\n* if you want to install everything in a row, use as suggested above the `--all` option\n\n\n## Updating / Upgrading\n\nUpgrading is normally as simple as:\n\n     $\u003e make -C ~/.dotfiles update\n\nOR, if you prefer a more atomic approach:\n\n     $\u003e cd ~/.dotfiles\n     $\u003e make update\n\nNote that if you wish to __upgrade__ the Git submodules to the latest version, you should run:\n\n     $\u003e make upgrade\n\n## Uninstalling / Removing the ULHPC dotfiles\n\nYou can use `install.sh --delete` to remove the ULHPC dotfiles.\n\n__`/!\\ IMPORTANT`__: pay attention to use the options matching you installation package.\n\n* if you have installed __all__ the dotfiles, run:\n\n```bash\n     $\u003e ./install.sh --delete --all     # OR make uninstall\n```\n\n* if you have installed __only__ a subpart of the dotfiles, adapt the command line option. Ex:\n\n```bash\n     $\u003e ./install.sh --delete --vim --git\n```\n\n\n## What's included and how to customize?\n\n| Tools                                                                          | Type                  | Installation            | Documentation                                |\n|--------------------------------------------------------------------------------|-----------------------|-------------------------|----------------------------------------------|\n| [Bourne-Again shell (bash)](http://tiswww.case.edu/php/chet/bash/bashtop.html) | shell                 | `./install.sh --bash`   | [`bash/README.md`](bash/README.md)           |\n| [VI iMproved (vim)](http://www.vim.org/)                                       | editor                | `./install.sh --vim`    | [`vim/README.md`](vim/README.md)             |\n| [Git `--fast-version-control`](https://git-scm.com/)                           | VCS                   | `./install.sh --git`    | [`git/README.md`](git/README.md)             |\n| [GNU screen](https://www.gnu.org/software/screen/)                             | terminal multiplexers | `./install.sh --screen` | [`screen/README.md`](screen/README.md)       |\n| [SSH](http://www.openssh.com/)                                                 | remote shell          | `./install.sh --ssh`    | [`ssh/README.md`](ssh/README.md)       |\n|                                                                                |                       |                         |                                              |\n\nAs mentioned above, if you want to install all dotfiles in one shot, just use\n\n      $\u003e ./install.sh --all      # OR 'make install'\n\n## Issues / Feature request\n\nYou can submit bug / issues / feature request using the [`ULHPC/dotfiles` Project Tracker](https://github.com/ULHPC/dotfiles/issues) or the [UL HPC Tracker](https://hpc-tracker.uni.lu).\n\n## Developments / Contributing to the code\n\nIf you want to contribute to the code, you shall be aware of the way this repository is organized and developed.\nThese elements are detailed on `docs/contributing/`\n\n## Licence\n\nThis project is released under the terms of the [GPL-3.0](LICENCE) licence.\n\n[![Licence](https://www.gnu.org/graphics/gplv3-88x31.png)](http://www.gnu.org/licenses/gpl-3.0.html)\n\n## Resources\n\nWe have created this repository using various contributions on the Internet, in particular:\n\n* [Your unofficial guide to dotfiles on GitHub](https://dotfiles.github.io/)\n* [S.Varrette's dotfiles](https://github.com/Falkor/dotfiles)\n* [H.Cartiaux's dotfiles](https://github.com/hcartiaux/dotfiles)\n* [Holman's does dotfiles](https://github.com/holman/dotfiles), for his idea of bundling the [homebrew](http://brew.sh) configuration\n* [Mathias’s dotfiles](https://github.com/mathiasbynens/dotfiles),  for featuring `~/.osx` _i.e._ sensible hacker defaults for OS X;\n* [Awesome dotfiles](https://github.com/webpro/awesome-dotfiles), a curated list of dotfiles resources. Inspired by the [awesome](https://github.com/sindresorhus/awesome) list thing.\n* [Carlo's dotfiles](https://github.com/caarlos0/dotfiles)\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fulhpc%2Fdotfiles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fulhpc%2Fdotfiles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fulhpc%2Fdotfiles/lists"}