-
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
677db19
commit 08cb525
Showing
2 changed files
with
185 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,65 +1,140 @@ | ||
<!-- markdownlint-disable MD033 MD041 MD043 --> | ||
|
||
<img | ||
src="https://kura.pro/dotfiles/v2/images/logos/dotfiles.svg" | ||
alt="dotfiles logo" | ||
alt="Dotfiles logo" | ||
width="66" | ||
align="right" | ||
/> | ||
|
||
<!-- markdownlint-enable MD033 MD041 --> | ||
|
||
# Dotfiles (v0.2.469) | ||
|
||
Designed to seamlessly enhance your shell environment 🐚 | ||
**Seamlessly enhance your shell environment 🐚** | ||
|
||
![Dotfiles banner][banner] | ||
|
||
## 🅲🅳 🅰🅻🅸🅰🆂🅴🆂 | ||
--- | ||
|
||
## 🚀 Introduction | ||
|
||
This repository includes a robust set of shell aliases and scripts designed to streamline your command-line experience. The `cd` aliases script simplifies filesystem navigation with: | ||
|
||
- **Dynamic error handling** | ||
- **Automatic directory listing** | ||
- **Customizable paths for frequent directories** | ||
|
||
--- | ||
|
||
## 🛠️ Features | ||
|
||
### 🌟 Navigation Shortcuts | ||
|
||
| Alias | Description | | ||
|------------------|--------------------------------------| | ||
| `-` | Switch to the previous directory | | ||
| `..`, `...` | Ascend one or two levels in the tree | | ||
| `....`, `.....` | Ascend three or four levels | | ||
| `hom` | Navigate to the home directory (`~`) | | ||
|
||
--- | ||
|
||
### 📂 Custom Directory Access | ||
|
||
Quickly access frequently used directories with predefined shortcuts. You can customize these paths to fit your needs: | ||
|
||
| Alias | Directory Path | Description | | ||
|-------|--------------------------|------------------------| | ||
| `app` | `${HOME}/Applications` | Applications directory | | ||
| `cod` | `${HOME}/Code` | Code directory | | ||
| `des` | `${HOME}/Desktop` | Desktop directory | | ||
| `doc` | `${HOME}/Documents` | Documents directory | | ||
| `dot` | `${HOME}/.dotfiles` | Dotfiles directory | | ||
| `dow` | `${HOME}/Downloads` | Downloads directory | | ||
| `mus` | `${HOME}/Music` | Music directory | | ||
| `pic` | `${HOME}/Pictures` | Pictures directory | | ||
| `vid` | `${HOME}/Videos` | Videos directory | | ||
|
||
--- | ||
|
||
### 🔧 System Directories | ||
|
||
Effortlessly navigate to critical system directories: | ||
|
||
| Alias | Directory Path | Description | | ||
|-------|----------------|--------------------------------| | ||
| `etc` | `/etc` | System configuration directory | | ||
| `var` | `/var` | Variable files directory | | ||
| `tmp` | `/tmp` | Temporary files directory | | ||
|
||
--- | ||
|
||
### ⚙️ Enhanced Customization | ||
|
||
- **Dynamic Directory Paths**: Customize aliases through environment variables | ||
- **Error Handling**: Provides clear messages for invalid directories | ||
- **Optional Directory Listing**: Automatically lists contents after navigation | ||
- **Tab Completion**: Supports custom tab completion for aliases | ||
|
||
--- | ||
|
||
## 📦 Installation | ||
|
||
1. **Clone the repository**: | ||
```bash | ||
git clone https://github.com/sebastienrousseau/dotfiles.git | ||
``` | ||
|
||
2. **Source the script in your shell configuration**: | ||
|
||
```bash | ||
echo 'source /path/to/dotfiles/cd.sh' >> ~/.bashrc | ||
``` | ||
|
||
3. **Reload your shell**: | ||
|
||
```bash | ||
source ~/.bashrc | ||
``` | ||
|
||
--- | ||
|
||
## 🧑💻 Usage | ||
|
||
Here are some examples of how you can use the `cd` aliases: | ||
|
||
This set of `cd` command aliases provides an intuitive and efficient way to | ||
navigate your filesystem. Incorporating dynamic error handling, optional | ||
directory listing, and customization for an improved command-line experience. | ||
```bash | ||
# Navigate to the Code directory | ||
cod | ||
|
||
### Setup | ||
# Ascend two levels in the directory tree | ||
... | ||
|
||
To use these aliases, integrate the script into your `.bashrc` or `.bash_profile`. | ||
# Access the Documents directory | ||
doc | ||
|
||
### Navigation Shortcuts | ||
# Navigate to the system configuration directory | ||
etc | ||
``` | ||
|
||
* `-`: Go to the previous directory. | ||
* `..`, `...`, `....`, `.....`: Ascend one to four levels in the directory tree. | ||
* `~`: Navigate to the home directory. | ||
--- | ||
|
||
### Custom Directory Access | ||
## 📚 Documentation | ||
|
||
Leverage aliases for quick access to frequently visited directories: | ||
For advanced configuration and detailed usage examples, visit the [official documentation](https://dotfiles.io). | ||
|
||
* `app`: Applications directory | ||
* `cod`: Code directory | ||
* `des`: Desktop directory | ||
* `doc`: Documents directory | ||
* `dot`: Dotfiles directory | ||
* `dow`: Downloads directory | ||
* `mus`: Music directory | ||
* `pic`: Pictures directory | ||
* `vid`: Videos directory | ||
--- | ||
|
||
### System Directories | ||
## 🛡️ License | ||
|
||
Quickly access system directories: | ||
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT). | ||
|
||
* `etc`: System configuration (`/etc`) | ||
* `var`: Variable files (`/var`) | ||
* `tmp`: Temporary files (`/tmp`) | ||
--- | ||
|
||
### Enhanced Customization | ||
## 👨💻 Author | ||
|
||
Customize directory paths through environment variables to suit your system's | ||
structure and preferences. Use concise aliases (`app`, `cod`, `des`, etc.) for | ||
efficient navigation. | ||
Created with ♥ by [Sebastien Rousseau](https://sebastienrousseau.com) | ||
|
||
For a detailed guide on configuring and using these aliases, plus additional | ||
information on each command, visit our [documentation](https://dotfiles.io). | ||
- Website: [https://sebastienrousseau.com](https://sebastienrousseau.com) | ||
- GitHub: [https://github.com/sebastienrousseau](https://github.com/sebastienrousseau) | ||
|
||
[banner]: https://kura.pro/dotfiles/v2/images/titles/title-dotfiles.svg |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters