# cf-auth

> Codeforces authenticator

Latest version **1.0.2** (published 2016-03-05) · MPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install cf-auth
pnpm add cf-auth
yarn add cf-auth
bun add cf-auth
```

Provides the command `cfauth`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2016-03-05 |
| First published | 2016-03-01 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Manuel Pineda |
| Maintainers | pin3da |
| Keywords | codeforces, api, authentication, auth |

## Links

- npm: https://www.npmjs.com/package/cf-auth
- Repository: https://github.com/pin3da/cf-auth
- Homepage: https://github.com/pin3da/cf-auth#readme
- Issues: https://github.com/pin3da/cf-auth/issues
- npm.io page: https://npm.io/package/cf-auth

## Dependencies (1)

- [randomstring](https://npm.io/package/randomstring.md) ^1.1.4

## Alternatives

- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads
- [escher-request](https://npm.io/package/escher-request.md) — 545 weekly downloads

## Recent versions

- 1.0.2 (latest) — 2016-03-05
- 1.0.1 — 2016-03-02
- 1.0.0 — 2016-03-01

## README

cf-auth
=======

cf-auth is an authenticator for the [Codeforces API](http://codeforces.com/api/help)

Install
=======

    npm install cf-auth

global install

    npm install cf-auth -g


Usage
=====

you can use it from command line by passing a 'keys file' and a target url.

    cfauth "path_to_keys" "target_URL"

Example using curl:

    cfauth  "my_keys.js" "http://codeforces.com/api/contest.status?contestId=566&from=1&count=10" | xargs curl

You also can require it from another nodejs program:

```javascript
var CFAuth = require('./index.js');
var keys = require('./keys.js');

var auth = CFAuth(keys);

var target = 'http://codeforces.com/api/user.rating?handle=Fefer_Ivan';
console.log(auth.genURL(target));
```

Licensing
=========

The project is released under the MPLv2 license.

Please see LICENSE for full details.

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