{"id":14262637,"url":"https://github.com/hipstersmoothie/octokit-cli","last_synced_at":"2025-04-11T17:42:18.838Z","repository":{"id":35093987,"uuid":"205776502","full_name":"hipstersmoothie/octokit-cli","owner":"hipstersmoothie","description":"A CLI for @octokit/rest","archived":false,"fork":false,"pushed_at":"2024-10-21T07:33:01.000Z","size":1113,"stargazers_count":25,"open_issues_count":19,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-21T10:39:06.042Z","etag":null,"topics":["cli","github","octokit"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hipstersmoothie.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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":"2019-09-02T04:26:26.000Z","updated_at":"2024-08-20T02:52:35.000Z","dependencies_parsed_at":"2023-01-15T13:42:01.772Z","dependency_job_id":"5fda6675-4967-4368-87f1-b2f1bb432916","html_url":"https://github.com/hipstersmoothie/octokit-cli","commit_stats":{"total_commits":36,"total_committers":2,"mean_commits":18.0,"dds":0.4444444444444444,"last_synced_commit":"256932ecc8edc56e46737a10d95ddd1badcc2941"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hipstersmoothie%2Foctokit-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hipstersmoothie%2Foctokit-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hipstersmoothie%2Foctokit-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hipstersmoothie%2Foctokit-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hipstersmoothie","download_url":"https://codeload.github.com/hipstersmoothie/octokit-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248451662,"owners_count":21105911,"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":["cli","github","octokit"],"created_at":"2024-08-22T13:01:53.941Z","updated_at":"2025-04-11T17:42:18.812Z","avatar_url":"https://github.com/hipstersmoothie.png","language":"TypeScript","readme":"# `octokit-cli`\n\nA cli for [@octokit/rest](https://octokit.github.io/rest.js/).\n\n\u003e NOTE: This a WIP side-project. If you want to see this project do something it doesn't feel free to contribute! Currently the descriptions could use some work.\n\nFeatures:\n\n:rocket: Run any octokit endpoint from the CLI\n\n:rocket: Automatically detect certain args in CI (owner, repo, issue_number)\n\n![Example showing fuzzy searching for an emoji](./example.gif)\n\n## Installation\n\nYou can either install `octokit-cli` to your project:\n\n```sh\nnpm i --save-dev octokit-cli\n# or\nyarn add -D octokit-cli\n```\n\nOr globally on your computer:\n\n```sh\nnpm i -g octokit-cli\n```\n\n## Usage\n\nMost commands require authentication to work. To authenticate create a [personal-access-token](https://github.com/settings/tokens) then set `GH_TOKEN` to the token.\n\nLocally you can add your `GH_TOKEN` to a file at the root of your project named `.env`.\n\n```sh\nGH_TOKEN=YOUR_PERSONAL_ACCESS_TOKEN\n```\n\nNow when you run `octokit-cli` you do not have to include your `GH_TOKEN`.\n\n### Commands\n\n`octokit-cli` is a thin wrapper around [@octokit/rest](https://octokit.github.io/rest.js/) so it has a very similar API.\n\nTo get help for every command just add the `--help` flag.\n\n### Examples\n\n_Create a status on a PR_:\n\n```sh\noctokit repos create-status --owner hipstersmoothie --repo octokit-cli --state error --sha b3859f9e787145c904aee28668e20960b8407e2 --context \"My Status\"\n```\n\n_Create a comment on a PR_:\n\n```sh\noctokit issues create-comment --body \"My Comment\" --owner hipstersmoothie --repo octokit-cli --issue_number 26\n```\n\n_Fuzzy find an emoji_:\n\nUsing [fzf](https://github.com/junegunn/fzf)\n\n```sh\noctokit emojis get | fzf\n```\n\n### Commands in CI\n\nWhen run from a continuos integration (CI) environment, `octokit-cli` will detect the `owner`, `repo`, and `issue_number` and set these as defaults when running a command.\n\nFor example, if you ran the following command from a PR in your CI it would automatically include `owner`, `repo`, and `issue_number`. If ran locally these arguments would be required.\n\n```sh\noctokit issues create-comment --body \"My Comment\"\n```\n\n## Contributing\n\nIf you want a feature or can fix a bug, submit a PR!\n\nIf you think a particular endpoint can be formatted better for the CLI, add a formatter in `src/formatters`.\n\n### Developing\n\nFirst install the dependencies:\n\n```sh\nyarn\n```\n\n#### Scripts\n\n- `yarn start` - Build the CLI and watch for changes\n- `yarn build` - Create a build of the CLI\n","funding_links":[],"categories":["cli"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhipstersmoothie%2Foctokit-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhipstersmoothie%2Foctokit-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhipstersmoothie%2Foctokit-cli/lists"}