Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/luismayta/zsh-functions

functions for zsh
https://github.com/luismayta/zsh-functions

automation functions peru plugin tools zsh

Last synced: 7 days ago
JSON representation

functions for zsh

Host: GitHub
URL: https://github.com/luismayta/zsh-functions
Owner: luismayta
License: lgpl-3.0
Created: 2019-11-18T06:13:34.000Z (almost 5 years ago)
Default Branch: develop
Last Pushed: 2023-02-07T23:11:36.000Z (over 1 year ago)
Last Synced: 2024-04-13T03:47:05.305Z (7 months ago)
Topics: automation, functions, peru, plugin, tools, zsh
Language: Shell
Homepage:
Size: 5.23 MB
Stars: 7
Watchers: 3
Forks: 0
Open Issues: 16
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/code_of_conduct.md

Awesome Lists containing this project

README

[![Latest Release](https://img.shields.io/github/release/luismayta/zsh-functions)](https://github.com/luismayta/zsh-functions/releases) [![Lint](https://img.shields.io/github/workflow/status/luismayta/zsh-functions/lint-code)](https://github.com/luismayta/zsh-functions/actions?workflow=lint-code) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow)](https://conventionalcommits.org) [![KeepAChangelog](https://img.shields.io/badge/Keep%20A%20Changelog-1.0.0-%23E05735)](https://keepachangelog.com)

# zsh-functions

zsh-functions plugin for zsh.

## Requirements

This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:

- [docker](https://www.docker.com)
- [python](https://www.python.org)
- [taskfile](https://github.com/go-task/task)

## Installation
### [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) users

If you're using [oh-my-zsh](https://gitub.com/robbyrussell/oh-my-zsh), install this plugin by doing the following:

1. Go to your oh-my-zsh custom plugins directory -`cd ~/.oh-my-zsh/custom/plugins`
2. Clone the plugin `bash git clone https://github.com/luismayta/zsh-functions`bash
3. Edit your `.zshrc` and add `plugins=( ... zsh-functions )` to your list of plugins
4. Open a new terminal and enjoy!
### [antigen](https://github.com/zsh-users/antigen) users

If you're using [Antigen](https://github.com/zsh-users/antigen), install this plugin by doing the following:

1. Add `antigen bundle luismayta/zsh-functions` to your `.zshrc` where you're adding your other plugins.
2. Either open a new terminal to force zsh to load the new plugin, or run `antigen bundle luismayta/zsh-functions` in a running zsh session.
3. Enjoy!
### [antibody](https://github.com/getantibody/antibody) users

If you're using [Antibody](https://github.com/getantibody/antibody), install this plugin by doing the following:

1. Add :

```{.sourceCode .bash}
antibody bundle luismayta/zsh-functions
```

to your `.zshrc` where you're adding your other plugins.

2. Either open a new terminal to force zsh to load the new plugin, or run `antibody bundle luismayta/zsh-functions` in a running zsh session.
3. Enjoy!

## Functions

zsh cheat includes a small utility `cheat` to fetch and install new packages.

#### `cheat::install`

Install cheat.

#### `cheat::post_install`

Install sync config and cheatsheets.

#### `cheat::cheatsheets::install`

Install all cheatsheet to path cheat.

#### `cheat::sync`

sync config cheatsheet to local.

#### `fcheat`

search cheat using fzf.

## Help

**Got a question?**

File a GitHub [issue](https://github.com/luismayta/zsh-functions/issues).

## Contributing

### Bug Reports & Feature Requests

Please use the [issue tracker](https://github.com/luismayta/zsh-functions/issues) to report any bugs or file feature requests.

### Development

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. **Fork** the repo on GitHub
2. **Clone** the project to your own machine
3. **Commit** changes to your own branch
4. **Push** your work back up to your fork
5. Submit a **Pull Request** so that we can review your changes

**NOTE:** Be sure to rebase the latest changes from "upstream" before making a pull request!

## Module Versioning

This Module follows the principles of [Semantic Versioning (SemVer)](https://semver.org/).

Using the given version number of `MAJOR.MINOR.PATCH`, we apply the following constructs:

1. Use the `MAJOR` version for incompatible changes.
1. Use the `MINOR` version when adding functionality in a backwards compatible manner.
1. Use the `PATCH` version when introducing backwards compatible bug fixes.

### Backwards compatibility in `0.0.z` and `0.y.z` version

- In the context of initial development, backwards compatibility in versions `0.0.z` is **not guaranteed** when `z` is
increased. (Initial development)
- In the context of pre-release, backwards compatibility in versions `0.y.z` is **not guaranteed** when `y` is
increased. (Pre-release)

## Copyright

## Trademarks

All other trademarks referenced herein are the property of their respective owners.

## License

The code and styles are licensed under the LGPL-3.0 license [See project license.](LICENSE).

## Don't forget to 🌟 Star 🌟 the repo if you like zsh-functions

[Your feedback is appreciated](https://github.com/luismayta/zsh-functions/issues)