Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amalfra/recorder
A go package to capture stdout and stderr generated by your code :camera:
https://github.com/amalfra/recorder
capture go golang stderr stdout
Last synced: 2 months ago
JSON representation
A go package to capture stdout and stderr generated by your code :camera:
- Host: GitHub
- URL: https://github.com/amalfra/recorder
- Owner: amalfra
- License: mit
- Created: 2017-08-06T09:52:52.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-09T11:25:58.000Z (9 months ago)
- Last Synced: 2024-10-12T12:25:59.958Z (3 months ago)
- Topics: capture, go, golang, stderr, stdout
- Language: Go
- Homepage:
- Size: 24.4 KB
- Stars: 15
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
recorder
========
[](https://github.com/amalfra/recorder/releases)
[](https://godoc.org/github.com/amalfra/recorder/v3)
[](https://goreportcard.com/report/github.com/amalfra/recorder/v3)
[](https://coveralls.io/github/amalfra/recorder?branch=main)
A go package to capture stdout and stderr generated by your code
## Installation
You can download the package using
```sh
go get github.com/amalfra/recorder/v3
```
## Usage
Next, import the package
``` go
import (
"github.com/amalfra/recorder/v3"
)
```
You can record output from both Stdout as well as Stderr. The recorded output will be available as string. The following two structs are available for your use:
* recorder.Stdout - Can be used for recording from Stdout
* recorder.Stderr - Can be used for recording from Stderr
There are four struct methods which can be used to control recording process:
* Start - To start recording
* Stop - To stop recording
* GetOutput - To return recorded output as string
* ClearOutput - To clear the recorded output
To record follow below steps:
1. first create the instance of struct as follows:
```go
rec := new(recorder.Stdout)
```
or if to record from Stderr do
```go
rec := new(recorder.Stderr)
```
2. Now call the ```Start``` method as follows:
```go
rec.Start()
```
From now onwards all Stdout or Stderr output will be captured.
3. Call ```Stop``` method as follows when you want to stop recording process:
```go
rec.Stop()
```
4. Now get the recorded output by calling the ```GetOutput``` method. It will return the recorded output string
```go
out := rec.GetOutput()
```
## Development
Questions, problems or suggestions? Please post them on the [issue tracker](https://github.com/amalfra/recorder/issues).
You can contribute changes by forking the project and submitting a pull request. You can ensure the tests are passing by running ```make test```. Feel free to contribute :heart_eyes:
## UNDER MIT LICENSE
The MIT License (MIT)
Copyright (c) 2017 Amal Francis
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.