ONWARDS
βοΈ What's this?
Onwards is a command line tool for managing port-forwards in Kubernetes environments. It can start and stop port-forwards and display logs from each port-forward. It automatically retries a port-forward if it disconnects. Onwards uses a config file which will make it super simple to port-forward to necessary services for the entire team.
π Prerequisites
To get started with Onwards, you need to have the following installed:
π Getting Started
To use Onwards, you can install it globally using Yarn or NPM:
npm install -g onwards
Or if you prefer using Yarn:
yarn global add onwards
Alternatively, you can run it without installing by using npx
:
npx onwards
π» Local Development
To develop on Onwards locally, follow these steps:
- Clone the repository:
git clone https://github.com/username/onwards.git
π - Install the dependencies:
npm install
oryarn
π - Start Onwards:
npm start
oryarn start
π
onwards.json
.
βοΈ Configuration
Onwards uses a configuration file called onwards.json
to define the port-forwarding services. Here is an example configuration file:
{
"services": [
{
"name": "service",
"command": "kubectl port-forward another-service 5000:5000"
},
{
"name": "another service",
"command": "kubectl port-forward another-service 5001:5000"
}
]
}
kubectl port-forward
does, you can learn more about it in the Kubernetes documentation.
Each service
object in the services
array has a name
and a command
property. The name
property is a descriptive name for the service, and the command
property is the command to start the port-forward.
πͺ Contributing
If you encounter any issues or have suggestions for how to improve Onwards, please feel free to open an issue or a pull request on our GitHub repository. We welcome contributions of all kinds!
π License
This project is licensed under the MIT License.