https://github.com/continuous-foundation/orcid

A utility and CLI to work with ORCID (https://orcid.org) in your applications.
https://github.com/continuous-foundation/orcid

Last synced: 5 months ago
JSON representation

A utility and CLI to work with ORCID (https://orcid.org) in your applications.

• Host: GitHub
• URL: https://github.com/continuous-foundation/orcid
• Owner: continuous-foundation
• License: mit
• Created: 2022-12-23T22:11:15.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-29T22:47:53.000Z (over 1 year ago)
• Last Synced: 2025-10-20T11:55:22.299Z (8 months ago)
• Language: TypeScript
• Size: 1010 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# orcid

[![orcid on npm](https://img.shields.io/npm/v/orcid.svg)](https://www.npmjs.com/package/orcid)

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/continuous-foundation/orcid/blob/main/LICENSE)

![CI](https://github.com/continuous-foundation/orcid/workflows/CI/badge.svg)

A utility and CLI to work with [ORCID](https://orcid.org) in your applications.

## Install

```bash

npm install orcid

```

## Using the Command Line

Use the `search` command to find an ORCID given an authors full name (in quotes). The query is powered by OpenAlex, and gives a publication hint, last known institution, and concepts that the author publishes about. The command only returns results for authors with ORCIDs.

```bash

orcid search "rowan cockett"

> Found 1 result for "rowan cockett" with an ORCID:

> Rowan Cockett

> 0000-0002-7859-8394

>   Hint: SimPEG: An open source framework for simulation ...

>   Last Institution: University of British Columbia

>   Concepts: Geology, Computer science, Engineering, Physics ...

```

## Using Node

```ts

import { orcid } from 'orcid';

const isValid = orcid.validate('https://orcid.org/0000-0002-7859-8394');

orcid.buildUrl('http://orcid.org/0000-0002-7859-8394');

orcid.buildUrl('https://www.orcid.org/0000-0002-7859-8394');

orcid.buildUrl('0000-0002-7859-8394');

// These all point to https://orcid.org/0000-0002-7859-8394

```

## Included Utilities

- `validate` - Validates if a single ORCID string is valid

- `normalize` - Normalizes an ORCID url or string into a ORCID identifier of the form `0000-0002-7859-8394`

- `buildUrl` - Builds a URL to https://orcid.org, includes normalization

## Options

- `strict`: only accept the ID part without the URL

---

As of v1.0.0 this package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).

---



  Made with love by

  

    Continuous Science Foundation