https://github.com/laughedelic/fishkit
Plugin scaffolder for fish
https://github.com/laughedelic/fishkit
Last synced: 6 months ago
JSON representation
Plugin scaffolder for fish
- Host: GitHub
- URL: https://github.com/laughedelic/fishkit
- Owner: laughedelic
- License: mit
- Created: 2016-05-08T12:01:48.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-05-08T12:46:10.000Z (over 9 years ago)
- Last Synced: 2025-02-12T19:39:38.575Z (8 months ago)
- Language: Shell
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Build Status][travis-badge]][travis-link]
[![Slack Room][slack-badge]][slack-link]
# fishkit
Plugin scaffolder for [fish].
## Install
With [fisherman]
```
fisher fishkit
```
## Usage
```
fishkit [TEMPLATE]
```
Or with a [strings](#strings) file.
```
fishkit TEMPLATE < strings.yaml
```
## Example
```
fishkit plugin
```
```
❯ What's your plugin name? tron
❯ What's your plugin about? It's just pong
❯ What's your GitHub username? flynn
.editorconfig
.gitignore
.travis.yml
completions/tron.fish
functions/tron.fish
LICENSE
README.md
```
## Strings
```
fishkit TEMPLATE < strings.yml
```
```yml
name: tron
description: It's just pong
author: Kevin Flynn
owner: flynn
```
## Templates
The available templates are:
* [Plugin]
* [Prompt]
* [Snippet]
[fisherman]: https://github.com/fisherman/fisherman
[slack-link]: https://fisherman-wharf.herokuapp.com
[slack-badge]: https://fisherman-wharf.herokuapp.com/badge.svg
[travis-link]: https://travis-ci.org/fisherman/fishkit
[travis-badge]: https://img.shields.io/travis/fisherman/fishkit.svg
[Plugin]: https://github.com/fisherman/fishkit/tree/master/templates/plugin
[Prompt]: https://github.com/fisherman/fishkit/tree/master/templates/prompt
[Snippet]: https://github.com/fisherman/fishkit/tree/master/templates/snippet
[fish]: https://fishshell.com