https://github.com/dmarshaltu/logstreamtoo.cr
LogStreamTool is a Crystal application for streaming and monitoring logs from Kubernetes pods. It allows you to easily stream logs from a specific pod to your favorite text editor.
https://github.com/dmarshaltu/logstreamtoo.cr
crystal crystal-lang crystal-language k8s kubernetes
Last synced: 12 months ago
JSON representation
LogStreamTool is a Crystal application for streaming and monitoring logs from Kubernetes pods. It allows you to easily stream logs from a specific pod to your favorite text editor.
- Host: GitHub
- URL: https://github.com/dmarshaltu/logstreamtoo.cr
- Owner: DmarshalTU
- License: mit
- Created: 2024-01-17T01:05:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-17T01:19:27.000Z (about 2 years ago)
- Last Synced: 2025-03-30T18:46:39.137Z (12 months ago)
- Topics: crystal, crystal-lang, crystal-language, k8s, kubernetes
- Language: Crystal
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LogStreamTool
LogStreamTool is a Crystal application for streaming and monitoring logs from Kubernetes pods. It allows you to easily stream logs from a specific pod to your favorite text editor.
## Features
- Stream logs from a Kubernetes pod.
- Choose your preferred text editor (vim, neovim, code, etc.).
- Seamless integration with Kubernetes.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Configuration](#configuration)
- [Contributing](#contributing)
- [License](#license)
## Installation
download from release pre-built and run:
```shell
# chmod +x if need it
./logstream
### Prerequisites
Make sure you have Kubernetes CLI (`kubectl`) installed on your system.
### Build the Application
```shell
git clone https://github.com/DmarshalTU/LogStreamToo.cr.git
cd logstream-tool
shards build --release
```
## Usage
```shell
./logstream --namespace mynamespace --pod-name mypod --editor vim
### Options
--namespace: Specify the Kubernetes namespace (default: default).
--pod-name: Specify the pod name (default: nginx).
--editor: Choose your text editor (vim, neovim, code, etc.).
```
## Development
TODO: Write development instructions here
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Denis Tu](https://github.com/dmarshaltu) - creator and maintainer