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

https://github.com/adeboyed/portal

A command line tool for running commands with no dependencies.
https://github.com/adeboyed/portal

Last synced: 8 months ago
JSON representation

A command line tool for running commands with no dependencies.

Awesome Lists containing this project

README

          

# Portal
> Using Docker on the command line seamlessly.

[![GitHub license](https://img.shields.io/badge/license-Apache-blue.svg)](https://github.com/adeboyed/portal/blob/master/LICENSE)

`portal` is a command line tool for running commands with no dependencies.
Instead of installing a language stack, dependencies, libraries and more, you can use docker containers to run commands as if they were installed on your local machine.
It removes a lot of the bookeeping required to transfer data and files to and from the docker container.

portal [COMMAND] [COMMAND OPTIONS]

## Example
For example, you can format your latex document:

portal latexindent report.tex

Or convert a jpeg to webp:

portal webp input_file.jpeg -o output_file.webp

## Installation

Portal requires Python 3+ to run and Docker to be installed and running.

### Simple Installation

pip install -r requirements.txt # Install required pip dependencies
make
make install

### Developer Installation

If you need to make changes/test out a new command, you can use `portal` directly as a Python module

pip install -r requirements.txt # Install required pip dependencies
python -m portalcli

## Supported Commands

- http-server
- cwebp
- httpie
- gollum
- shellcheck
- surge
- openapi-generator-cli
- [And more!](./wiki/COMMANDS.md)

*Interactive commands are currently unsupported*

## Documentation

- [List of supported commands](./wiki/COMMANDS.md)
- [How to add a new command](./wiki/ADD_NEW_COMMAND.md)

## License

Portal is [Apache licensed](./LICENSE).