https://github.com/softprops/atty

are you or are you not a tty?
https://github.com/softprops/atty

library rust rust-library tty

Last synced: 5 months ago
JSON representation

are you or are you not a tty?

• Host: GitHub
• URL: https://github.com/softprops/atty
• Owner: softprops
• License: mit
• Created: 2015-07-03T18:13:49.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-07-18T16:22:13.000Z (about 1 year ago)
• Last Synced: 2025-05-08T00:05:50.369Z (5 months ago)
• Topics: library, rust, rust-library, tty
• Language: Rust
• Size: 795 KB
• Stars: 279
• Watchers: 11
• Forks: 51
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# atty

> [!WARNING]

> This is crate is no longer maintained and users are encouraged to prefer

> the equivalant functionality of [std.io.IsTerminal](https://doc.rust-lang.org/std/io/trait.IsTerminal.html), introduced in [Rust 1.70.0](https://blog.rust-lang.org/2023/06/01/Rust-1.70.0.html#isterminal)

>

> Thank you for your support!

[![Build Status](https://travis-ci.org/softprops/atty.svg?branch=master)](https://travis-ci.org/softprops/atty) [![Build status](https://ci.appveyor.com/api/projects/status/geggrsnsjsuse8cv?svg=true)](https://ci.appveyor.com/project/softprops/atty) [![Coverage Status](https://coveralls.io/repos/softprops/atty/badge.svg?branch=master&service=github)](https://coveralls.io/github/softprops/atty?branch=master) [![crates.io](https://img.shields.io/crates/v/atty.svg)](https://crates.io/crates/atty) [![Released API docs](https://docs.rs/atty/badge.svg)](http://docs.rs/atty) [![Master API docs](https://img.shields.io/badge/docs-master-green.svg)](https://softprops.github.io/atty)

> are you or are you not a tty?

## install

Add the following to your `Cargo.toml`

```toml

[dependencies]

atty = "0.2"

```

## usage

```rust

use atty::Stream;

fn main() {

  if atty::is(Stream::Stdout) {

    println!("I'm a terminal");

  } else {

    println!("I'm not");

  }

}

```

## testing

This library has been unit tested on both unix and windows platforms (via appveyor).

A simple example program is provided in this repo to test various tty's. By default.

It prints

```bash

$ cargo run --example atty

stdout? true

stderr? true

stdin? true

```

To test std in, pipe some text to the program

```bash

$ echo "test" | cargo run --example atty

stdout? true

stderr? true

stdin? false

```

To test std out, pipe the program to something

```bash

$ cargo run --example atty | grep std

stdout? false

stderr? true

stdin? true

```

To test std err, pipe the program to something redirecting std err

```bash

$ cargo run --example atty 2>&1 | grep std

stdout? false

stderr? false

stdin? true

```

Doug Tangren (softprops) 2015-2019