Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/markbates/jim
https://github.com/markbates/jim
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/markbates/jim
- Owner: markbates
- License: mit
- Created: 2019-11-13T15:50:07.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-01-06T21:15:50.000Z (almost 5 years ago)
- Last Synced: 2024-06-21T00:17:38.070Z (6 months ago)
- Language: Go
- Homepage:
- Size: 43.9 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Jim
Jim is a task runner, similiar to [https://github.com/markbates/grift](https://github.com/markbates/grift).
### Requirements
* Go 1.13+
* Modules
## Installation
```bash
$ go get github.com/markbates/jim/cmd/jim
```
---
## Usage
To create a new task that you can run with jim. You need to create a package level function with the following API in your module:
```go
func (ctx context.Context, args []string) error {
return nil
}
```
You can place these functions anywhere in your application in any package. You don't need to follow any naming conventions or use any special build tags. Your function need only take a [`context#Context`](https://godoc.org/context#Context) and a slice of `string`, and return an error.
See the [./examples/ref](./examples/ref) application for the full code.
```text
.
├── db
│ ├── seed
│ │ └── users.go
│ └── seed.go
├── go.mod
├── go.sum
├── ref.go
└── task
└── task.go
3 directories, 6 files
```
The `go.mod` file:
```go
module ref
go 1.13
```
Example task `ref/db/seed/users.go`
```go
package seed
import (
"context"
"fmt"
)
// Users puts all of the users into all of the databases
func Users(ctx context.Context, args []string) error {
fmt.Println("loading users", args)
return nil
}
```
### Running a Task via CLI
To run the above mentioned task we can use the `jim` command:
```bash
$ jim db/seed.Users 1 2 3 4
loading users [1 2 3 4]
```
Let's break down the `db/seed.Users` bit, shall we? The last part, `Users` is the name of the function that will be run. This **MUST** match capitalization.
The `db/seed` part is converted to the package `/db/seed` which, hopefully, contains a `Users` function that matches the correct API.
### Running a Task via API
To run your task via the API in your application, give it a `context.Context`, some arguments, and you're good to go. :)
### Getting Task Help
The `jim -h` flag, followed by the task will print the GoDoc for that function.
```bash
$ jim -h db/seed.Users
package seed // import "ref/db/seed"
func Users(ctx context.Context, args []string) error
Users puts all of the users into all of the databases
```
## Listing Available Tasks
```bash
$ jim list
ref/db/seed.Users
ref/db.Seed
ref/task.Another
ref/task.Something
```