Metadata-Version: 2.4
Name: seashells
Version: 1.0.0
Summary: The official client for Seashells.io
Project-URL: homepage, https://github.com/anishathalye/seashells
Project-URL: repository, https://github.com/anishathalye/seashells.git
Project-URL: issues, https://github.com/anishathalye/seashells/issues
Author-email: Anish Athalye <me@anishathalye.com>
License-File: LICENSE.md
Keywords: seashells,seashells.io,shell
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Version Control
Classifier: Topic :: Utilities
Requires-Python: >=2.7
Description-Content-Type: text/markdown

# Seashells [![Build Status](https://github.com/anishathalye/seashells/workflows/CI/badge.svg)](https://github.com/anishathalye/seashells/actions?query=workflow%3ACI) [![PyPI](https://img.shields.io/pypi/v/seashells.svg)](https://pypi.org/pypi/seashells/) [![Python 2.7+](https://img.shields.io/badge/python-2.7%2B-blue)](https://pypi.org/pypi/seashells/)

The official client for [seashells.io](https://seashells.io).

The server code is available at [anishathalye/seashells-server](https://github.com/anishathalye/seashells-server).

For more information, see [seashells.io](https://seashells.io) or the [launch blog post](https://www.anishathalye.com/2017/07/10/seashells/).

## Installation

Seashells is compatible with both Python 2 and Python 3. It's recommended that you use Python 3.

You can install Seashells from [PyPI](https://pypi.org/project/seashells/):

``` bash
pip install seashells
```

## Usage

See the instructions on [seashells.io](https://seashells.io) for more information about Seashells. For more information on how to use the command line tool itself, see the built-in help:

``` bash
seashells --help
```

### Tips and Tricks

- To easily pipe both stdout and stderr to seashells, you can set up a shell function ([source](https://github.com/anishathalye/seashells/issues/14#issuecomment-409167113)):

    ``` bash
    function sea() {
        $* 2>&1 | seashells
    }
    ```

## Other Clients

- [roccomuso/seashells](https://github.com/roccomuso/seashells) (Node.js)
- [hans-strudle/seashells](https://github.com/hans-strudle/seashells) (Go)

Note: other clients are not officially supported.

## License

Copyright (c) Anish Athalye. Released under the MIT License. See [LICENSE.md](LICENSE.md) for details.
