├── .editorconfig ├── .gitattributes ├── .github └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── cli.js ├── license ├── package.json ├── readme.md └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: ubuntu-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 20 14 | - 18 15 | - 16 16 | steps: 17 | - uses: actions/checkout@v3 18 | - uses: actions/setup-node@v3 19 | with: 20 | node-version: ${{ matrix.node-version }} 21 | - run: npm install 22 | - run: npm test 23 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /cli.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | import process from 'node:process'; 3 | import meow from 'meow'; 4 | import githubUsername from 'github-username'; 5 | 6 | const cli = meow(` 7 | Usage 8 | $ github-username [--token=] 9 | 10 | Example 11 | $ github-username sindresorhus@gmail.com 12 | sindresorhus 13 | `, { 14 | importMeta: import.meta, 15 | }); 16 | 17 | const email = cli.input[0]; 18 | const {token} = cli.flags; 19 | 20 | if (!email) { 21 | console.error('Specify an email'); 22 | process.exit(1); 23 | } 24 | 25 | console.log(await githubUsername(email, {token})); 26 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Sindre Sorhus (https://sindresorhus.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "github-username-cli", 3 | "version": "4.0.0", 4 | "description": "Get a GitHub username from an email address", 5 | "license": "MIT", 6 | "repository": "sindresorhus/github-username-cli", 7 | "funding": "https://github.com/sponsors/sindresorhus", 8 | "author": { 9 | "name": "Sindre Sorhus", 10 | "email": "sindresorhus@gmail.com", 11 | "url": "https://sindresorhus.com" 12 | }, 13 | "type": "module", 14 | "bin": { 15 | "github-username": "cli.js" 16 | }, 17 | "engines": { 18 | "node": ">=16" 19 | }, 20 | "scripts": { 21 | "test": "xo && ava" 22 | }, 23 | "files": [ 24 | "cli.js" 25 | ], 26 | "keywords": [ 27 | "cli-app", 28 | "cli", 29 | "github", 30 | "user", 31 | "username", 32 | "email", 33 | "address", 34 | "gh", 35 | "git" 36 | ], 37 | "dependencies": { 38 | "github-username": "^8.0.0", 39 | "meow": "^12.0.1" 40 | }, 41 | "devDependencies": { 42 | "ava": "^5.3.1", 43 | "execa": "^7.2.0", 44 | "xo": "^0.55.0" 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # github-username-cli 2 | 3 | > Get a GitHub username from an email address 4 | 5 | *Only works for users that have their email publicly listed on their profile.* 6 | 7 | ## Install 8 | 9 | ```sh 10 | npm install --global github-username-cli 11 | ``` 12 | 13 | ## Usage 14 | 15 | ``` 16 | $ github-username --help 17 | 18 | Usage 19 | $ github-username [--token=] 20 | 21 | Example 22 | $ github-username sindresorhus@gmail.com 23 | sindresorhus 24 | ``` 25 | 26 | ## Related 27 | 28 | - [github-username](https://github.com/sindresorhus/github-username) - API for this module 29 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import {execa} from 'execa'; 3 | 4 | test('main', async t => { 5 | const {stdout} = await execa('./cli.js', ['sindresorhus@gmail.com']); 6 | t.is(stdout, 'sindresorhus'); 7 | }); 8 | --------------------------------------------------------------------------------