# sauth

> Social auth from the command line

Latest version **0.0.4** (published 2014-09-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install sauth
pnpm add sauth
yarn add sauth
bun add sauth
```

Provides the command `sauth`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2014-09-10 |
| First published | 2014-09-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Joseph Werle |
| Maintainers | werle |
| Keywords | social, auth, command, line, cli |

## Links

- npm: https://www.npmjs.com/package/sauth
- Repository: https://github.com/jwerle/sauth
- Issues: https://github.com/jwerle/sauth/issues
- npm.io page: https://npm.io/package/sauth

## Dependencies (2)

- [batch](https://npm.io/package/batch.md) ^0.5.1
- [minimist](https://npm.io/package/minimist.md) ^1.1.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2014-09-10
- 0.0.3 — 2014-09-04
- 0.0.2 — 2014-09-04

## README

sauth
=====

Command line social authentication strategies

## install

```sh
$ npm i sauth -g
```

## about

*sauth* makes use of strategies for authentication. The goal of a
strategy is to authenticate a user with some type of authentication
control flow like OAuth. A strategy is devised into asynchronous phases.
The end result is usually to output an access token and/or user
information in the terminal. Implementing a strategy is fairly trivial
and only involves writing a few interface functions. See
[sauth-instagram](https://github.com/jwerle/sauth-instagram) for a
simple example.

## usage

`sauth(1)` is meant to be used as a command line utility. The basic
usage is:

```sh
usage: sauth [-hV] <strategy> [-c config] [...args]
```

where `strategy` is the name of the strategy to use. It is required
internally as `sauth-{NAME}` and should exists in one of the paths found
in `module.paths`. Arguments are passed to the strategy as an object and
are up to the strategy implementor. The argument `--client-id=1234` is
serialized into an object `{'client-id': 1234}` and passed to the
strategy as the fist argument. The second argument is a callback that
should be invoked after the strategy has completed.

The `-c` or `--config` argument is a path to a JSON or javascript file
that will be the arguments passed to the strategy itself. This makes it
convenient for running strategies from the command line.

**example:**

```json
{
  "client_id": "1234",
  "client_secret": "5678",
  "redirect_uri": "http://localhost:9999/ig/auth",
  "port": 9999
}
```

```sh
$ sauth instagram -c ig-strategy-conf.json
```

## license

MIT

---
_Source: https://npm.io/package/sauth · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._