https://github.com/foomo/posh

Project Oriented Shell (posh)
https://github.com/foomo/posh

foomo foomo-posh posh

Last synced: about 2 months ago
JSON representation

Project Oriented Shell (posh)

• Host: GitHub
• URL: https://github.com/foomo/posh
• Owner: foomo
• License: mit
• Created: 2023-01-03T14:37:00.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-17T11:21:31.000Z (9 months ago)
• Last Synced: 2024-10-19T15:10:32.317Z (9 months ago)
• Topics: foomo, foomo-posh, posh
• Language: Go
• Homepage: https://www.foomo.org
• Size: 352 KB
• Stars: 5
• Watchers: 12
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![Build Status](https://github.com/foomo/posh/actions/workflows/test.yml/badge.svg?branch=main&event=push)](https://github.com/foomo/posh/actions/workflows/test.yml)

[![Go Report Card](https://goreportcard.com/badge/github.com/foomo/posh)](https://goreportcard.com/report/github.com/foomo/posh)

[![Coverage Status](https://coveralls.io/repos/github/foomo/posh/badge.svg?branch=main&)](https://coveralls.io/github/foomo/posh?branch=main)

[![GoDoc](https://godoc.org/github.com/foomo/posh?status.svg)](https://godoc.org/github.com/foomo/posh)



  



# Project Oriented SHELL (posh)

> think of `posh` as an interactive and hackable Makefile

## Installing

Install the latest release of the cli:

````bash

$ brew update

$ brew install foomo/tap/posh

````

## Usage

```shell

$ posh help

Project Oriented Shell (posh)

Usage:

  posh [command]

Available Commands:

  completion  Generate the autocompletion script for the specified shell

  config      Print loaded configuration

  help        Help about any command

  init        Initialize a Project Oriented Shell

  version     Print the version

Flags:

  -h, --help           help for posh

      --level string   set log level (default: info) (default "info")

      --no-color       disabled colors (default: false)

Use "posh [command] --help" for more information about a command.

```

To start using posh, go into your project and run:

```bash

$ cd your/project

$ posh init

```

This will generate the standard layout for posh which can be changed as required through `.posh.yml`.

Once initialized you can start posh through:

```bash

$ make shell

```

## How to Contribute

Please refer to the [CONTRIBUTING](.gihub/CONTRIBUTING.md) details and follow the [CODE_OF_CONDUCT](.gihub/CODE_OF_CONDUCT.md) and [SECURITY](.github/SECURITY.md) guidelines.

## License

Distributed under MIT License, please see license file within the code for more details.

_Made with ♥ [foomo](https://www.foomo.org) by [bestbytes](https://www.bestbytes.com)_