# gauge

**Repository Path**: thoughtworks/gauge

## Basic Information

- **Project Name**: gauge
- **Description**:  Light weight cross-platform test automation 
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 16
- **Forks**: 10
- **Created**: 2021-06-03
- **Last Updated**: 2021-12-08

## Categories & Tags

**Categories**: testing

**Tags**: None

## README

![Gauge Logo](Gauge-Logo.png)


[![Actions Status](https://github.com/getgauge/gauge/workflows/build/badge.svg)](https://github.com/getgauge/gauge/actions)

[![Ask at StackOverflow](https://img.shields.io/badge/StackOverflow-getgauge-F5C10E.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAAnFBMVEUAAADs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PHs8PG3iEVjAAAAM3RSTlMAAQMGBwkLDA0QExweKS4wMzc4PkdJT1JdY2dvc3WDjpiam6avtcfMz9ng4ubp7fHz9/tqGqSaAAAAfUlEQVQYGV3BBw6CQABFwb/YUOy9IIpgb8i7/92ErBLCjKzGKzAqa185tVTmhCR9/ZmoJy1gY2QN4DIy3oNjXVY3gvu0HfN09dPZwXsdRsqNb8GkY5rblE9NuRWZNF7O9r4sx5sfEjKeJJDlDv2zAwJREAhEQSBQCYgKUfEFJ7oYF2usUEAAAAAASUVORK5CYII=)](https://stackoverflow.com/questions/ask?tags=getgauge)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)

# Welcome to Gauge

Gauge is a light weight cross-platform test automation tool. It provides the ability to author test cases in the business language.

## Get Started
Read more about [Why Gauge](https://gauge.org/2018/05/15/why-we-built-gauge/) can be used, its [terminologies](https://docs.gauge.org/writing-specifications.html) and [**get started...**](https://docs.gauge.org/getting_started/installing-gauge.html)

## Find out more

| **[User Docs][userdocs]**     | **[Setup Guide][get-started]**     | **[Examples][examples]**           | **[Contributing][contributing]**           | **[Brand Style Guide][branding]**           |
|:-------------------------------------:|:-------------------------------:|:-----------------------------------:|:---------------------------------------------:|:---------------------------------------------:|
| [![i1][userdocs-image]][userdocs]<br>Learn more about using Gauge | [![i2][getstarted-image]][get-started]<br> Getting started with Gauge | [![i3][examples-image]][examples]<br>Some Gauge Examples | [![i4][contributing-image]][contributing]<br>How can you contribute to Gauge? | [![i5][branding-image]][branding]<br>Gauge brand colours, logos, images etc. |

[userdocs-image]:https://d3i6fms1cm1j0i.cloudfront.net/github/images/techdocs.png
[getstarted-image]:https://d3i6fms1cm1j0i.cloudfront.net/github/images/setup.png
[examples-image]:https://d3i6fms1cm1j0i.cloudfront.net/github/images/roadmap.png
[contributing-image]:https://d3i6fms1cm1j0i.cloudfront.net/github/images/contributing.png
[branding-image]:https://d3i6fms1cm1j0i.cloudfront.net/github/images/setup.png

[userdocs]:https://docs.gauge.org/
[get-started]:https://github.com/getgauge/gauge/wiki/Setup
[examples]:https://getgauge-examples.github.io/
[contributing]:CONTRIBUTING.md
[branding]:https://brand.gauge.org/

## Questions or need help?

### Troubleshooting
Context specific **Troubleshooting** guide is available in relevant pages of the [Gauge Documentation](https://docs.gauge.org/).

### Talk to us

Please see below for the best place to ask a query:

- How do I? -- [Discussions](https://github.com/getgauge/gauge/discussions)
- I got this error, why? -- [Discussions](https://github.com/getgauge/gauge/discussions)
- I got this error and I'm sure it's a bug -- file an [issue](https://github.com/getgauge/gauge/issues)
- I have an idea/request -- file an [issue](https://github.com/getgauge/gauge/issues)
- Why do you? -- [Discussions](https://github.com/getgauge/gauge/discussions)
- When will you? -- [Discussions](https://github.com/getgauge/gauge/discussions)

### Other projects

Also maintained by Gauge

- [Taiko](https://github.com/getgauge/taiko) Headless web browser automation.

## Add Gauge Badge to your project!
Copy the text below and add it to the README.md of your project using Gauge, and show your support. It looks like this:

[![Gauge Badge](https://gauge.org/Gauge_Badge.svg)](https://gauge.org)

```
[![Gauge Badge](https://gauge.org/Gauge_Badge.svg)](https://gauge.org)
```

## License

Gauge is released under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full license text.

## Copyright

Copyright 2018 ThoughtWorks, Inc.