{"id":13452517,"url":"https://github.com/useshortcut/shortcut-client-js","last_synced_at":"2026-01-27T22:28:26.889Z","repository":{"id":40745891,"uuid":"56009352","full_name":"useshortcut/shortcut-client-js","owner":"useshortcut","description":"The official JavaScript client library for the Shortcut (formerly Clubhouse) REST API.","archived":false,"fork":false,"pushed_at":"2024-03-29T15:56:34.000Z","size":2260,"stargazers_count":130,"open_issues_count":6,"forks_count":31,"subscribers_count":30,"default_branch":"main","last_synced_at":"2024-05-15T14:32:15.641Z","etag":null,"topics":["api","api-client","javascript","javascript-client","node","nodejs","shortcut","shortcut-api","shortcut-lib","typescript"],"latest_commit_sha":null,"homepage":"https://useshortcut.github.io/shortcut-client-js/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/useshortcut.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-04-11T21:34:52.000Z","updated_at":"2024-07-23T00:22:45.982Z","dependencies_parsed_at":"2023-02-06T14:31:47.927Z","dependency_job_id":"2a793807-b7e9-4dd6-af4f-ee9f3afb82d6","html_url":"https://github.com/useshortcut/shortcut-client-js","commit_stats":null,"previous_names":["clubhouse/clubhouse-lib","useshortcut/clubhouse-lib"],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useshortcut%2Fshortcut-client-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useshortcut%2Fshortcut-client-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useshortcut%2Fshortcut-client-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/useshortcut%2Fshortcut-client-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/useshortcut","download_url":"https://codeload.github.com/useshortcut/shortcut-client-js/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247242669,"owners_count":20907133,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-client","javascript","javascript-client","node","nodejs","shortcut","shortcut-api","shortcut-lib","typescript"],"created_at":"2024-07-31T07:01:26.386Z","updated_at":"2026-01-27T22:28:26.884Z","avatar_url":"https://github.com/useshortcut.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# @shortcut/client\n\n\u003cimg height=\"125\" src=\"https://github.com/user-attachments/assets/7c3d3b8e-6252-4790-81cd-6640cd46a2d6\" alt=\"Shortcut's logo\" align=\"right\"\u003e\n\n[![Version](https://badge.fury.io/js/@shortcut%2Fclient.svg)](https://badge.fury.io/js/@shortcut%2Fclient)\n[![Monthly Downloads](https://img.shields.io/npm/dm/@shortcut%2Fclient)](https://www.npmjs.org/package/@shortcut%2Fclient)\n[![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/useshortcut/shortcut-client-js/blob/main/LICENSE)\n[![PRs welcome!](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)]()\n[![X](https://img.shields.io/twitter/follow/shortcut.svg?label=Follow%20@shortcut)](https://twitter.com/intent/follow?screen_name=shortcut)\n\nA library for interacting with the Shortcut REST API.\n\n\u003cbr /\u003e\n\n## Getting Started\n\n### Installation\n\n```shell\nnpm install @shortcut/client\n```\n\n\u003e [!IMPORTANT]\n\u003e Our legacy npm organization namespace is `@useshortcut`.\n\u003e\n\u003e While it will still contain copies of all future released package versions, we **strongly** recommend switching to our primary `@shortcut` organization namespace.\n\n### How to Get an API Token\n\nThe Shortcut API uses token-based authentication, you will need one to use this library.\n\nTo generate an API token, go to https://app.shortcut.com/settings/account/api-tokens.\n\nTo make it easier to explore our API, we recommend saving this token as an environment variable in your local dev environment:\n\n```bash\nexport SHORTCUT_API_TOKEN=\"YOUR API TOKEN HERE\"\n```\n\nThis will allow you to copy and paste many examples in the documentation to try them out.\n\n\u003e [!NOTE]\n\u003e Requests made with a missing or invalid token will get a `401 Unauthorized` response.\n\n\u003e [!NOTE]\n\u003e All requests must be made over HTTPS.\n\n\u003e [!CAUTION]\n\u003e Tokens provide complete access to your Shortcut account, **so keep them secure**.\n\u003e\n\u003e Don’t paste them into your source code, use an environment variable instead.\n\u003e\n\u003e For security reasons, we will immediately invalidate any tokens we find have been made public.\n\n## Usage\n\nTo see all available exports, take a look at the [API documentation](https://useshortcut.github.io/shortcut-client-js/) or check out the `.d.ts` files in this repository.\n\n```javascript\nimport { ShortcutClient } from '@shortcut/client';\n// const { ShortcutClient } = require('@shortcut/client');\n\nconst shortcut = new ShortcutClient('YOUR_API_TOKEN'); // See https://github.com/useshortcut/shortcut-client-js#how-to-get-an-api-token\n\nshortcut.getCurrentMemberInfo().then((response) =\u003e console.log(response?.data));\n\nshortcut.listProjects().then((response) =\u003e console.log(response?.data));\n```\n\n## Play with It\n\nYou can play with it in your web browser with this live playground:\n\n- [CodeSandbox](https://codesandbox.io/s/useshortcut-client-playground-48kq1)\n\n## Documentation\n\n[Documentation for this client](https://useshortcut.github.io/shortcut-client-js/).\n\n[Documentation for the REST API](https://developer.shortcut.com/api/rest/v3).\n\n## Publishing \u0026 Deployment\n\nThis library uses GitHub Actions for CI/CD. The deployment process is fully automated.\n\n### Release Process\n\nTo publish a new version:\n\n1. Update the version in `package.json`\n2. Commit and push to `main`\n3. Create a GitHub Release with a version tag (e.g., `v2.4.0`)\n4. The publish workflow will automatically build and publish to npm\n\n### Publishing to npm\n\nPublishing is triggered automatically when a **GitHub Release is created**:\n\n1. **Create a GitHub Release**: Go to the repository's Releases page and create a new release with a version tag (e.g., `v2.4.0`)\n2. The `publish.yml` workflow will:\n   - Build the package (`yarn build` via `prepublishOnly`)\n   - Publish to npm under `@shortcut/client`\n   - Also publish under the legacy `@useshortcut/client` namespace for backwards compatibility\n\n### Documentation Deployment\n\nAPI documentation is automatically deployed to GitHub Pages on every push to `main`:\n\n1. The `gh-pages.yml` workflow builds the documentation using TypeDoc\n2. Documentation is published to https://useshortcut.github.io/shortcut-client-js/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuseshortcut%2Fshortcut-client-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuseshortcut%2Fshortcut-client-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuseshortcut%2Fshortcut-client-js/lists"}