# is-railway
**Check if the current process is running inside Railway.**
[](https://github.com/1chiSensei/is-railway/blob/main/LICENSE)
[](https://crates.io/crates/is-railway)
**Table of Contents**
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Basic Usage](#basic-usage)
- [CLI](#cli)
- [Contributors ✨](#contributors-%E2%9C%A8)
## Features
- Written in Rust
- Fast and lightweight
- Uses no dependencies
## Installation
You can use the following command to install this package.
```sh
cargo install is-railway
```
Or as a dependency.
```toml
# Cargo.toml
[dependencies]
is-railway = "1.0.1"
```
## Usage
**Note:** When using as a CLI, it exits with code 0 if running in Railway and 2 if not.
### Basic Usage
```rust
use is_railway::check;
fn main() {
let is_running_on_railway = check();
println!("{}", is_running_on_railway);
}
```
### CLI
```sh
$ is-railway
```
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
