├── .editorconfig ├── .eslintignore ├── .eslintrc ├── .github ├── dependabot.yml └── workflows │ ├── automerge.yml │ ├── failureNotifications.yml │ ├── manualRelease.yml │ ├── notify-slack-on-pr-open.yml │ ├── onPushToMain.yml │ └── onRelease.yml ├── .gitignore ├── .mocharc.json ├── .vscode └── launch.json ├── LICENSE ├── README.md ├── bin ├── dev ├── dev.cmd ├── run └── run.cmd ├── package-lock.json ├── package.json ├── src ├── commands │ ├── ask.ts │ ├── auth.ts │ └── model.ts ├── helpers │ └── index.ts ├── index.ts └── types.ts └── tsconfig.json /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = space 5 | indent_size = 2 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.md] 11 | trim_trailing_whitespace = false 12 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | /dist 2 | -------------------------------------------------------------------------------- /.eslintrc: -------------------------------------------------------------------------------- 1 | { 2 | "extends": [ 3 | "oclif-typescript" 4 | ] 5 | } 6 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: 'npm' 4 | directory: '/' 5 | schedule: 6 | interval: 'weekly' 7 | day: 'saturday' 8 | versioning-strategy: 'increase' 9 | labels: 10 | - 'dependencies' 11 | open-pull-requests-limit: 5 12 | pull-request-branch-name: 13 | separator: '-' 14 | commit-message: 15 | # cause a release for non-dev-deps 16 | prefix: fix(deps) 17 | # no release for dev-deps 18 | prefix-development: chore(dev-deps) 19 | ignore: 20 | - dependency-name: '@salesforce/dev-scripts' 21 | - dependency-name: '*' 22 | update-types: ['version-update:semver-major'] 23 | -------------------------------------------------------------------------------- /.github/workflows/automerge.yml: -------------------------------------------------------------------------------- 1 | name: automerge 2 | on: 3 | workflow_dispatch: 4 | 5 | jobs: 6 | automerge: 7 | uses: oclif/github-workflows/.github/workflows/automerge.yml@main 8 | secrets: inherit 9 | -------------------------------------------------------------------------------- /.github/workflows/failureNotifications.yml: -------------------------------------------------------------------------------- 1 | name: failureNotifications 2 | 3 | on: 4 | workflow_run: 5 | workflows: 6 | - version, tag and github release 7 | - publish 8 | types: 9 | - completed 10 | 11 | jobs: 12 | failure-notify: 13 | runs-on: ubuntu-latest 14 | if: ${{ github.event.workflow_run.conclusion == 'failure' }} 15 | steps: 16 | - name: Announce Failure 17 | id: slack 18 | uses: slackapi/slack-github-action@v1.21.0 19 | env: 20 | # for non-CLI-team-owned plugins, you can send this anywhere you like 21 | SLACK_WEBHOOK_URL: ${{ secrets.CLI_ALERTS_SLACK_WEBHOOK }} 22 | SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK 23 | with: 24 | payload: | 25 | { 26 | "text": "${{ github.event.workflow_run.name }} failed: ${{ github.event.workflow_run.repository.name }}", 27 | "blocks": [ 28 | { 29 | "type": "header", 30 | "text": { 31 | "type": "plain_text", 32 | "text": ":bh-alert: ${{ github.event.workflow_run.name }} failed: ${{ github.event.workflow_run.repository.name }} :bh-alert:" 33 | } 34 | }, 35 | { 36 | "type": "section", 37 | "text": { 38 | "type": "mrkdwn", 39 | "text": "Repo: ${{ github.event.workflow_run.repository.html_url }}\nWorkflow name: `${{ github.event.workflow_run.name }}`\nJob url: ${{ github.event.workflow_run.html_url }}" 40 | } 41 | } 42 | ] 43 | } 44 | -------------------------------------------------------------------------------- /.github/workflows/manualRelease.yml: -------------------------------------------------------------------------------- 1 | name: manual release 2 | 3 | on: 4 | workflow_dispatch: 5 | 6 | jobs: 7 | release: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: actions/checkout@v3 11 | with: 12 | token: ${{ secrets.SVC_CLI_BOT_GITHUB_TOKEN }} 13 | - name: Conventional Changelog Action 14 | id: changelog 15 | uses: TriPSs/conventional-changelog-action@d360fad3a42feca6462f72c97c165d60a02d4bf2 16 | # overriding some of the basic behaviors to just get the changelog 17 | with: 18 | git-user-name: svc-cli-bot 19 | git-user-email: svc_cli_bot@salesforce.com 20 | github-token: ${{ secrets.SVC_CLI_BOT_GITHUB_TOKEN }} 21 | output-file: false 22 | # always do the release, even if there are no semantic commits 23 | skip-on-empty: false 24 | tag-prefix: '' 25 | - uses: notiz-dev/github-action-json-property@2192e246737701f108a4571462b76c75e7376216 26 | id: packageVersion 27 | with: 28 | path: 'package.json' 29 | prop_path: 'version' 30 | - name: Create Github Release 31 | uses: actions/create-release@v1 32 | env: 33 | GITHUB_TOKEN: ${{ secrets.SVC_CLI_BOT_GITHUB_TOKEN }} 34 | with: 35 | tag_name: ${{ steps.packageVersion.outputs.prop }} 36 | release_name: ${{ steps.packageVersion.outputs.prop }} 37 | -------------------------------------------------------------------------------- /.github/workflows/notify-slack-on-pr-open.yml: -------------------------------------------------------------------------------- 1 | name: Pull Request Slack Notification 2 | 3 | on: 4 | pull_request: 5 | types: [opened, reopened] 6 | 7 | jobs: 8 | build: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - name: Notify Slack on PR open 12 | env: 13 | WEBHOOK_URL : ${{ secrets.CLI_TEAM_SLACK_WEBHOOK_URL }} 14 | PULL_REQUEST_AUTHOR_ICON_URL : ${{ github.event.pull_request.user.avatar_url }} 15 | PULL_REQUEST_AUTHOR_NAME : ${{ github.event.pull_request.user.login }} 16 | PULL_REQUEST_AUTHOR_PROFILE_URL: ${{ github.event.pull_request.user.html_url }} 17 | PULL_REQUEST_BASE_BRANCH_NAME : ${{ github.event.pull_request.base.ref }} 18 | PULL_REQUEST_COMPARE_BRANCH_NAME : ${{ github.event.pull_request.head.ref }} 19 | PULL_REQUEST_NUMBER : ${{ github.event.pull_request.number }} 20 | PULL_REQUEST_REPO: ${{ github.event.pull_request.head.repo.name }} 21 | PULL_REQUEST_TITLE : ${{ github.event.pull_request.title }} 22 | PULL_REQUEST_URL : ${{ github.event.pull_request.html_url }} 23 | uses: salesforcecli/github-workflows/.github/actions/prNotification@main 24 | -------------------------------------------------------------------------------- /.github/workflows/onPushToMain.yml: -------------------------------------------------------------------------------- 1 | # test 2 | name: version, tag and github release 3 | 4 | on: 5 | push: 6 | branches: [release] # Not triggering CI at the moment 7 | 8 | jobs: 9 | release: 10 | uses: oclif/github-workflows/.github/workflows/githubRelease.yml@main 11 | secrets: inherit 12 | 13 | # most repos won't use this 14 | # depends on previous job to avoid git collisions, not for any functionality reason 15 | # docs: 16 | # uses: salesforcecli/github-workflows/.github/workflows/publishTypedoc.yml@main 17 | # secrets: inherit 18 | # needs: release 19 | -------------------------------------------------------------------------------- /.github/workflows/onRelease.yml: -------------------------------------------------------------------------------- 1 | name: publish 2 | 3 | on: 4 | release: 5 | types: [released] 6 | # support manual release in case something goes wrong and needs to be repeated or tested 7 | workflow_dispatch: 8 | inputs: 9 | tag: 10 | description: tag that needs to publish 11 | type: string 12 | required: true 13 | jobs: 14 | npm: 15 | uses: oclif/github-workflows/.github/workflows/npmPublish.yml@main 16 | with: 17 | tag: latest 18 | githubTag: ${{ github.event.release.tag_name || inputs.tag }} 19 | secrets: inherit 20 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *-debug.log 2 | *-error.log 3 | /.nyc_output 4 | /dist 5 | /lib 6 | /tmp 7 | /yarn.lock 8 | node_modules 9 | oclif.manifest.json 10 | .env -------------------------------------------------------------------------------- /.mocharc.json: -------------------------------------------------------------------------------- 1 | { 2 | "require": [ 3 | "test/helpers/init.js", 4 | "ts-node/register" 5 | ], 6 | "watch-extensions": [ 7 | "ts" 8 | ], 9 | "recursive": true, 10 | "reporter": "spec", 11 | "timeout": 60000 12 | } 13 | -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.2.0", 3 | "configurations": [ 4 | { 5 | "type": "node", 6 | "request": "launch", 7 | "name": "Execute Command", 8 | "skipFiles": [ 9 | "/**" 10 | ], 11 | "program": "${workspaceFolder}/bin/dev", 12 | "args": [ 13 | "hello", 14 | "world", 15 | ], 16 | } 17 | ] 18 | } 19 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 |

GPT3 Powered CLI

3 | 4 |

5 | Oclif 6 | npm 7 | npm 8 | Hacker News 9 | 10 |

11 | 12 | 13 | 14 | 15 | 16 | ![image](https://user-images.githubusercontent.com/36589645/202654014-c1884be3-76d5-4b64-81d1-e3f1169fcb46.png) 17 | 18 | 19 | 20 | 21 | ### Installation 22 | 23 | You'd need to install it globally 24 | 25 | ``` 26 | npm i @abhagsain/ai-cli -g 27 | ``` 28 | 29 | Usage 30 | 31 | ``` 32 | $ ai ask "Check process running on port" 33 | ``` 34 | 35 | You'd need to enter your own OpenAI API key 36 | Here's how you can get one 37 | 38 | 1. Go to https://openai.com/api/login 39 | 2. Create an account or log into your existing account 40 | 3. Go to https://beta.openai.com/account/api-keys or 41 | image 42 | 4. Run `ai auth`, enter your API KEY and you're good to go! 43 | 44 | Pricing 45 | 46 | The current prompt length is `~800` tokens and average response length is `~40` tokens. The pricing for [`gpt-3.5-turbo`](https://openai.com/api/pricing/) is `$0.001` per `1K` input tokens and `$0.002` per `1K` output tokens which is ~`$0.0009/command`. We'll see if we can improve the response as well as reduce the per-command-cost with fine-tuning. 47 | 48 | ___ 49 | 50 | Add autocomplete by running `ai autocomplete` and follow the instructions. It's super easy. 51 | 52 | 53 | __ 54 | 55 | ### Liked this project? Checkout my other side project. [SlidesAI.io - AI Presentation Maker](https://slidesai.io/?ref=ai-cli) 56 | __ 57 | 58 | Auto generated documentation 59 | 60 | 61 | * [Usage](#usage) 62 | * [Commands](#commands) 63 | 64 | 65 | # Usage 66 | 67 | 68 | ```sh-session 69 | $ npm install -g @abhagsain/ai-cli 70 | $ ai COMMAND 71 | running command... 72 | $ ai (--version) 73 | @abhagsain/ai-cli/1.3.0 darwin-arm64 node-v18.0.0 74 | $ ai --help [COMMAND] 75 | USAGE 76 | $ ai COMMAND 77 | ... 78 | ``` 79 | 80 | 81 | # Commands 82 | 83 | 84 | * [`ai ask [question]`](#ai-ask-question) 85 | * [`ai auth`](#ai-auth) 86 | * [`ai autocomplete [SHELL]`](#ai-autocomplete-shell) 87 | * [`ai help [COMMAND]`](#ai-help-command) 88 | * [`ai model`](#ai-model) 89 | * [`ai update [CHANNEL]`](#ai-update-channel) 90 | 91 | ## `ai ask [question]` 92 | 93 | Ask question to GPT3 from your terminal 94 | 95 | ``` 96 | USAGE 97 | $ ai ask [question] 98 | 99 | ARGUMENTS 100 | QUESTION Your question 101 | 102 | DESCRIPTION 103 | Ask question to GPT3 from your terminal 104 | 105 | EXAMPLES 106 | $ ai ask "Check running process on port 3000" 107 | ``` 108 | 109 | _See code: [dist/commands/ask.ts](https://github.com/abhagsain/ai-cli/blob/v1.3.0/dist/commands/ask.ts)_ 110 | 111 | ## `ai auth` 112 | 113 | Update existing or add new OpenAI API Key 114 | 115 | ``` 116 | USAGE 117 | $ ai auth 118 | 119 | DESCRIPTION 120 | Update existing or add new OpenAI API Key 121 | 122 | EXAMPLES 123 | $ ai auth (Follow the prompt) 124 | ``` 125 | 126 | _See code: [dist/commands/auth.ts](https://github.com/abhagsain/ai-cli/blob/v1.3.0/dist/commands/auth.ts)_ 127 | 128 | ## `ai autocomplete [SHELL]` 129 | 130 | display autocomplete installation instructions 131 | 132 | ``` 133 | USAGE 134 | $ ai autocomplete [SHELL] [-r] 135 | 136 | ARGUMENTS 137 | SHELL shell type 138 | 139 | FLAGS 140 | -r, --refresh-cache Refresh cache (ignores displaying instructions) 141 | 142 | DESCRIPTION 143 | display autocomplete installation instructions 144 | 145 | EXAMPLES 146 | $ ai autocomplete 147 | 148 | $ ai autocomplete bash 149 | 150 | $ ai autocomplete zsh 151 | 152 | $ ai autocomplete --refresh-cache 153 | ``` 154 | 155 | _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.3.6/src/commands/autocomplete/index.ts)_ 156 | 157 | ## `ai help [COMMAND]` 158 | 159 | Display help for ai. 160 | 161 | ``` 162 | USAGE 163 | $ ai help [COMMAND] [-n] 164 | 165 | ARGUMENTS 166 | COMMAND Command to show help for. 167 | 168 | FLAGS 169 | -n, --nested-commands Include all nested commands in the output. 170 | 171 | DESCRIPTION 172 | Display help for ai. 173 | ``` 174 | 175 | _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.17/src/commands/help.ts)_ 176 | 177 | ## `ai model` 178 | 179 | Change model preference (default: gpt-3.5-turbo) 180 | 181 | ``` 182 | USAGE 183 | $ ai model 184 | 185 | DESCRIPTION 186 | Change model preference (default: gpt-3.5-turbo) 187 | 188 | EXAMPLES 189 | $ ai model (Follow the prompt) 190 | ``` 191 | 192 | _See code: [dist/commands/model.ts](https://github.com/abhagsain/ai-cli/blob/v1.3.0/dist/commands/model.ts)_ 193 | 194 | ## `ai update [CHANNEL]` 195 | 196 | update the ai CLI 197 | 198 | ``` 199 | USAGE 200 | $ ai update [CHANNEL] [-a] [-v | -i] [--force] 201 | 202 | FLAGS 203 | -a, --available Install a specific version. 204 | -i, --interactive Interactively select version to install. This is ignored if a channel is provided. 205 | -v, --version= Install a specific version. 206 | --force Force a re-download of the requested version. 207 | 208 | DESCRIPTION 209 | update the ai CLI 210 | 211 | EXAMPLES 212 | Update to the stable channel: 213 | 214 | $ ai update stable 215 | 216 | Update to a specific version: 217 | 218 | $ ai update --version 1.0.0 219 | 220 | Interactively select version: 221 | 222 | $ ai update --interactive 223 | 224 | See available versions: 225 | 226 | $ ai update --available 227 | ``` 228 | 229 | _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v3.0.7/src/commands/update.ts)_ 230 | 231 | -------------------------------------------------------------------------------- /bin/dev: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | const oclif = require('@oclif/core') 4 | 5 | const path = require('path') 6 | const project = path.join(__dirname, '..', 'tsconfig.json') 7 | 8 | // In dev mode -> use ts-node and dev plugins 9 | process.env.NODE_ENV = 'development' 10 | 11 | require('ts-node').register({project}) 12 | 13 | // In dev mode, always show stack traces 14 | oclif.settings.debug = true; 15 | 16 | // Start the CLI 17 | oclif.run().then(oclif.flush).catch(oclif.Errors.handle) 18 | -------------------------------------------------------------------------------- /bin/dev.cmd: -------------------------------------------------------------------------------- 1 | @echo off 2 | 3 | node "%~dp0\dev" %* -------------------------------------------------------------------------------- /bin/run: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | const oclif = require('@oclif/core') 4 | 5 | oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle')) 6 | -------------------------------------------------------------------------------- /bin/run.cmd: -------------------------------------------------------------------------------- 1 | @echo off 2 | 3 | node "%~dp0\run" %* 4 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@abhagsain/ai-cli", 3 | "version": "1.3.0", 4 | "description": "Get answers for CLI commands from GPT3 right from your terminal", 5 | "author": "Anurag Bhagsain @abhagsain", 6 | "bin": { 7 | "ai": "./bin/run" 8 | }, 9 | "homepage": "https://github.com/abhagsain/ai-cli", 10 | "license": "AGPL-3.0-or-later", 11 | "main": "dist/index.js", 12 | "repository": "abhagsain/ai-cli", 13 | "files": [ 14 | "/bin", 15 | "/dist", 16 | "/npm-shrinkwrap.json", 17 | "/oclif.manifest.json" 18 | ], 19 | "dependencies": { 20 | "@oclif/core": "^1.19.1", 21 | "@oclif/plugin-autocomplete": "^1.3.6", 22 | "@oclif/plugin-help": "^5", 23 | "@oclif/plugin-update": "^3.0.7", 24 | "chalk": "^4.1.2", 25 | "clipboardy": "^3.0.0", 26 | "fs-extra": "^10.1.0", 27 | "inquirer": "^8.2.2", 28 | "openai": "^4.24.7" 29 | }, 30 | "publishConfig": { 31 | "access": "public" 32 | }, 33 | "devDependencies": { 34 | "@oclif/test": "^2.2.8", 35 | "@types/chai": "^4", 36 | "@types/clipboardy": "^2.0.1", 37 | "@types/fs-extra": "^9.0.13", 38 | "@types/inquirer": "^8.2.1", 39 | "@types/mocha": "^9.0.0", 40 | "@types/node": "^16.18.3", 41 | "chai": "^4", 42 | "eslint": "^7.32.0", 43 | "eslint-config-oclif": "^4", 44 | "eslint-config-oclif-typescript": "^1.0.3", 45 | "mocha": "^9", 46 | "oclif": "^3", 47 | "shx": "^0.3.3", 48 | "ts-node": "^10.9.1", 49 | "tslib": "^2.3.1", 50 | "typescript": "^4.8.4" 51 | }, 52 | "oclif": { 53 | "bin": "ai", 54 | "dirname": "ai", 55 | "commands": "./dist/commands", 56 | "plugins": [ 57 | "@oclif/plugin-help", 58 | "@oclif/plugin-update", 59 | "@oclif/plugin-autocomplete" 60 | ], 61 | "topicSeparator": " ", 62 | "topics": { 63 | "hello": { 64 | "description": "Say hello to the world and others" 65 | } 66 | } 67 | }, 68 | "scripts": { 69 | "build": "shx rm -rf dist && tsc -b", 70 | "lint": "eslint . --ext .ts --config .eslintrc", 71 | "postpack": "shx rm -f oclif.manifest.json", 72 | "posttest": "yarn lint", 73 | "prepack": "yarn build && oclif manifest && oclif readme", 74 | "version": "oclif readme && git add README.md", 75 | "test": "echo \"No test specified\"" 76 | }, 77 | "engines": { 78 | "node": ">=12.0.0" 79 | }, 80 | "bugs": "https://github.com/abhagsain/ai-cli/issues", 81 | "keywords": [ 82 | "oclif", 83 | "gpt3", 84 | "ai-cli", 85 | "ai", 86 | "cli", 87 | "@abhagsain/ai-cli" 88 | ], 89 | "types": "dist/index.d.ts" 90 | } 91 | -------------------------------------------------------------------------------- /src/commands/ask.ts: -------------------------------------------------------------------------------- 1 | import { CliUx, Command } from "@oclif/core"; 2 | import chalk from "chalk"; 3 | import * as inquirer from "inquirer"; 4 | import { 5 | getCurrentModel, 6 | getDefaultMessages, 7 | getOpenAIKey, 8 | } from "../helpers/index"; 9 | import OpenAI from "openai"; 10 | 11 | export default class AI extends Command { 12 | static description = "Ask question to GPT3 from your terminal"; 13 | static usage = "ask [question]"; 14 | static help = `ai ask "Check if a remote port is open"`; 15 | 16 | static args = [ 17 | { 18 | name: "question", 19 | description: "Your question", 20 | required: true, 21 | }, 22 | ]; 23 | 24 | static examples = [ 25 | `$ <%= config.bin %> <%= command.id %> "Check running process on port 3000"`, 26 | ]; 27 | 28 | async getAnswersFromGPT3({ 29 | question, 30 | API_KEY, 31 | }: { 32 | question: string; 33 | API_KEY: string; 34 | }): Promise { 35 | const openai = new OpenAI({ 36 | apiKey: API_KEY || process.env.OPENAI_API_KEY, 37 | }); 38 | const messages = getDefaultMessages(); 39 | const { name: model } = getCurrentModel(this.config.configDir); 40 | try { 41 | const response = await openai.chat.completions.create({ 42 | model: model, 43 | messages: [...messages, { role: "user", content: question }], 44 | temperature: 0.8, 45 | max_tokens: 64, 46 | frequency_penalty: 0.5, 47 | presence_penalty: 0, 48 | stop: ['"""'], 49 | }); 50 | const code = /`(.*?)`/; 51 | const value = response.choices[0].message.content?.trim() || ""; 52 | const matches = value.match(code) || []; 53 | const match = matches.length > 1 ? matches[1] : value; 54 | return match; 55 | } catch (error: any) { 56 | // Error handling as suggested in openai v3->v4 migration guide 57 | // https://github.com/openai/openai-node/discussions/217 58 | if (error instanceof OpenAI.APIError) { 59 | throw new Error( 60 | JSON.stringify({ 61 | status: error.status, 62 | message: error.message, 63 | code: error.code, 64 | type: error.type, 65 | }) 66 | ); 67 | } else throw new Error(error.message); 68 | } 69 | } 70 | 71 | async showOptions(answer: string): Promise { 72 | const choices = ["Copy to clipboard", "Exit"]; 73 | 74 | const prompt: any = await inquirer.prompt([ 75 | { 76 | name: "command", 77 | message: "Select an option", 78 | type: "list", 79 | choices, 80 | }, 81 | ]); 82 | 83 | const { command } = prompt; 84 | switch (command) { 85 | case "Copy to clipboard": { 86 | const clipboardy = (await import("clipboardy")).default; 87 | clipboardy.writeSync(answer); 88 | break; 89 | } 90 | 91 | default: { 92 | return; 93 | } 94 | } 95 | } 96 | 97 | async run(): Promise { 98 | const API_KEY = await getOpenAIKey(this.config.configDir); 99 | if (!API_KEY) { 100 | this.log( 101 | "You haven't set your OpenAI API key. Please login with", 102 | chalk.bold.yellow("ai auth") 103 | ); 104 | return; 105 | } 106 | 107 | const { args } = await this.parse(AI); 108 | const { question } = args; 109 | CliUx.ux.action.start(""); 110 | const answer = await this.getAnswersFromGPT3({ 111 | question: question.trim(), 112 | API_KEY, 113 | }); 114 | CliUx.ux.action.stop(""); 115 | if (answer.toLowerCase().startsWith("sorry")) { 116 | this.log(answer); 117 | return; 118 | } 119 | this.log( 120 | `> ${chalk.green(`Command is`)} ${chalk.bold.yellowBright( 121 | `\`${answer}\`` 122 | )}\n` 123 | ); 124 | 125 | await this.showOptions((answer || "").trim()); 126 | this.log( 127 | `${chalk.red( 128 | "Please don't run a command that you don't understand." 129 | )} ${chalk.underline.red("Especially destructive commands")} ` 130 | ); 131 | } 132 | } 133 | -------------------------------------------------------------------------------- /src/commands/auth.ts: -------------------------------------------------------------------------------- 1 | import { Command } from "@oclif/core"; 2 | import chalk from "chalk"; 3 | import fs from "fs-extra"; 4 | import inquirer from "inquirer"; 5 | import { getAPIConfigFilePath, getOpenAIKey } from "../helpers/index"; 6 | 7 | export default class Auth extends Command { 8 | static description = "Update existing or add new OpenAI API Key"; 9 | 10 | static examples = ["<%= config.bin %> <%= command.id %> (Follow the prompt)"]; 11 | 12 | public async run(): Promise { 13 | const existingAPIKey = await getOpenAIKey(this.config.configDir); 14 | const filePath = getAPIConfigFilePath(this.config.configDir); 15 | 16 | const message = existingAPIKey 17 | ? "Please enter your OpenAI API Key (This would overwrite the existing key)" 18 | : "Please enter your OpenAI API Key"; 19 | const prompt = await inquirer.prompt([ 20 | { 21 | name: "userAPIKey", 22 | message, 23 | type: "password", 24 | validate: (value: string) => { 25 | if (!value.trim()) { 26 | return "Please enter a valid API key"; 27 | } 28 | return true; 29 | }, 30 | }, 31 | ]); 32 | 33 | const { userAPIKey } = prompt; 34 | fs.ensureFileSync(filePath); 35 | if (userAPIKey) { 36 | fs.writeFileSync(filePath, `OPENAI_API_KEY=${userAPIKey}`); 37 | } 38 | this.log(`API Key is saved at ${chalk.bold.yellowBright(filePath)}`); 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /src/commands/model.ts: -------------------------------------------------------------------------------- 1 | import { Command } from "@oclif/core"; 2 | import chalk from "chalk"; 3 | import * as inquirer from "inquirer"; 4 | import { 5 | defaultModel, 6 | getCurrentModel, 7 | models, 8 | saveModelPreference, 9 | } from "../helpers/index"; 10 | import { IModel } from "../types"; 11 | 12 | export default class Model extends Command { 13 | static description = `Change model preference (default: ${defaultModel.name})`; 14 | 15 | static examples = ["<%= config.bin %> <%= command.id %> (Follow the prompt)"]; 16 | 17 | public async run(): Promise { 18 | const currentModel = getCurrentModel(this.config.configDir); 19 | const prompt = await inquirer.prompt<{ modelName: IModel }>([ 20 | { 21 | name: "modelName", 22 | message: "Please select a model", 23 | type: "list", 24 | choices: models.map((model) => { 25 | const name = 26 | model.name === currentModel.name 27 | ? model.name + chalk.yellowBright(" (current)") 28 | : model.name; 29 | return { 30 | name: model.isLimitedBeta 31 | ? name + chalk.dim(" (limited beta)") 32 | : name, 33 | value: model, 34 | }; 35 | }), 36 | }, 37 | ]); 38 | const { modelName } = prompt; 39 | saveModelPreference(this.config.configDir, modelName); 40 | this.log( 41 | `\n✅ Model preference saved. You can change it anytime again with ${chalk.bold.yellow( 42 | "ai model" 43 | )}` 44 | ); 45 | } 46 | } 47 | -------------------------------------------------------------------------------- /src/helpers/index.ts: -------------------------------------------------------------------------------- 1 | import fs from "fs-extra"; 2 | import path from "path"; 3 | import { IModel } from "../types"; 4 | import OpenAI from "openai"; 5 | 6 | export const defaultModel = { 7 | name: "gpt-3.5-turbo", 8 | }; 9 | 10 | export const models: IModel[] = [defaultModel, { name: "gpt-4" }]; 11 | 12 | export const getOpenAIKey = async ( 13 | configDir: string 14 | ): Promise => { 15 | const filePath = getAPIConfigFilePath(configDir); 16 | if (fs.existsSync(filePath) && fs.statSync(filePath).isFile()) { 17 | const fileContent = await fs.readFile(filePath, "utf-8"); 18 | const [name, value] = fileContent?.split("=") || []; 19 | if (name === "OPENAI_API_KEY") { 20 | return value.trim(); 21 | } 22 | } 23 | return null; 24 | }; 25 | 26 | export const getAPIConfigFilePath = (configDir: string): string => 27 | path.join(configDir, ".ai-cli"); 28 | 29 | const getDataConfigFilePath = (dataDir: string): string => 30 | path.join(dataDir, "config.json"); 31 | 32 | export const getCurrentModel = (dataDir: string): typeof models[number] => { 33 | const config = getDataConfigFilePath(dataDir); 34 | const exists = fs.existsSync(config); 35 | if (!exists) { 36 | saveModelPreference(dataDir, defaultModel); 37 | } 38 | const { model: savedModel } = fs.readJsonSync(config); 39 | 40 | // To check if the saved model is in our defined list of models 41 | const isModelValid = models.find((model) => model.name === savedModel.name); 42 | 43 | if (!isModelValid) { 44 | saveModelPreference(dataDir, defaultModel); 45 | return defaultModel; 46 | } 47 | 48 | return savedModel; 49 | }; 50 | 51 | export const saveModelPreference = (dataDir: string, model: IModel): void => { 52 | const config = getDataConfigFilePath(dataDir); 53 | fs.writeJsonSync(config, { model }); 54 | }; 55 | 56 | type ChatMessage = { 57 | role: "system" | "user" | "assistant"; 58 | content: string; 59 | }; 60 | 61 | // From - https://github.com/abhagsain/ai-cli/issues/9#issuecomment-1324016570 62 | // Modified to new messages syntax 63 | const getPowerShellMessages = (): ChatMessage[] => [ 64 | { 65 | role: "system", 66 | content: 67 | "Correctly answer the asked question. Return 'Sorry, Can't answer that.' if the question isn't related to technology.", 68 | }, 69 | { role: "user", content: "get into a docker container." }, 70 | { role: "assistant", content: "`docker exec -it `" }, 71 | { role: "user", content: "Check what's listening on a port." }, 72 | { role: "assistant", content: "`netstat -ano | findstr :`" }, 73 | { role: "user", content: "How to ssh into a server with a specific file." }, 74 | { role: "assistant", content: "`ssh -i @`" }, 75 | { role: "user", content: "How to set relative line numbers in vim." }, 76 | { role: "assistant", content: "`:set relativenumber`" }, 77 | { role: "user", content: "How to create alias?" }, 78 | { role: "assistant", content: "`Set-Alias `" }, 79 | { role: "user", content: "Tail docker logs." }, 80 | { role: "assistant", content: "`docker logs -f mongodb`" }, 81 | { role: "user", content: "Forward port in kubectl." }, 82 | { 83 | role: "assistant", 84 | content: "`kubectl port-forward 8080:3000`", 85 | }, 86 | { role: "user", content: "Check if a port is accessible." }, 87 | { 88 | role: "assistant", 89 | content: "`Test-NetConnection -ComputerName -Port `", 90 | }, 91 | { role: "user", content: "Kill a process running on port 3000." }, 92 | { 93 | role: "assistant", 94 | content: 95 | "`Get-Process -Id (Get-NetTCPConnection -LocalPort 3000).OwningProcess | Stop-Process`", 96 | }, 97 | { role: "user", content: "Backup database from a mongodb container." }, 98 | { 99 | role: "assistant", 100 | content: 101 | '`docker exec -it mongodb bash -c "mongoexport --db mongodb --collection collections --outdir backup"`', 102 | }, 103 | { role: "user", content: "SSH Tunnel Remote Host port into a local port." }, 104 | { 105 | role: "assistant", 106 | content: 107 | "`ssh -L :: @`", 108 | }, 109 | { role: "user", content: "Copy local file to S3." }, 110 | { 111 | role: "assistant", 112 | content: "`aws s3 cp s3:///`", 113 | }, 114 | { role: "user", content: "Copy S3 file to local." }, 115 | { 116 | role: "assistant", 117 | content: "`aws s3 cp s3:/// `", 118 | }, 119 | { role: "user", content: "Recursively remove a folder." }, 120 | { role: "assistant", content: "`Remove-Item -Recurse `" }, 121 | { role: "user", content: "Copy a file from local to ssh server." }, 122 | { 123 | role: "assistant", 124 | content: "`scp /path/to/file user@server:/path/to/destination`", 125 | }, 126 | { role: "user", content: "Download a file from a URL." }, 127 | { 128 | role: "assistant", 129 | content: "`Invoke-WebRequest -Uri -OutFile `", 130 | }, 131 | { role: "user", content: "Git commit with message." }, 132 | { role: "assistant", content: '`git commit -m "my commit message"`' }, 133 | { role: "user", content: "Give a user sudo permissions." }, 134 | { 135 | role: "assistant", 136 | content: '`Add-LocalGroupMember -Group "Administrators" -Member `', 137 | }, 138 | { role: "user", content: "Check what's running on a port?" }, 139 | { 140 | role: "assistant", 141 | content: 142 | "`Get-Process -Id (Get-NetTCPConnection -LocalPort ).OwningProcess`", 143 | }, 144 | { role: "user", content: "View last 5 files from history" }, 145 | { role: "assistant", content: "`Get-History -Count 5`" }, 146 | { role: "user", content: "When was China founded?" }, 147 | { role: "assistant", content: "Sorry, Can't answer that." }, 148 | { role: "user", content: "Filter docker container with labels" }, 149 | { role: "assistant", content: '`docker ps --filter "label="`' }, 150 | { role: "user", content: "When was Abraham Lincon born?" }, 151 | { role: "assistant", content: "Sorry, Can't answer that." }, 152 | { role: "user", content: "Get into a running kubernetes pod" }, 153 | { role: "assistant", content: "`kubectl exec -it bash`" }, 154 | { role: "user", content: "Capital city of Ukrain?" }, 155 | { role: "assistant", content: "Sorry, Can't answer that." }, 156 | ]; 157 | 158 | const getUnixMessages = (): ChatMessage[] => [ 159 | { 160 | role: "system", 161 | content: 162 | "Correctly answer the asked question. Return 'Sorry, Can't answer that.' if the question isn't related to technology.", 163 | }, 164 | { role: "user", content: "get into a docker container." }, 165 | { role: "assistant", content: "`docker exec -it mongodb`" }, 166 | { role: "user", content: "Check what's listening on a port." }, 167 | { role: "assistant", content: "`lsof -i tcp:4000`" }, 168 | { role: "user", content: "How to ssh into a server with a specific file." }, 169 | { role: "assistant", content: "`ssh -i ~/.ssh/id_rsa user@127.0.0.1`" }, 170 | { role: "user", content: "How to set relative line numbers in vim." }, 171 | { role: "assistant", content: "`:set relativenumber`" }, 172 | { role: "user", content: "How to create alias?" }, 173 | { role: "assistant", content: '`alias my_command="my_real_command"`' }, 174 | { role: "user", content: "Tail docker logs." }, 175 | { role: "assistant", content: "`docker logs -f mongodb`" }, 176 | { role: "user", content: "Forward port in kubectl." }, 177 | { 178 | role: "assistant", 179 | content: "`kubectl port-forward 8080:3000`", 180 | }, 181 | { role: "user", content: "Check if a port is accessible." }, 182 | { role: "assistant", content: "`nc -vz host port`" }, 183 | { role: "user", content: "Reverse SSH Tunnel Syntax." }, 184 | { 185 | role: "assistant", 186 | content: 187 | "`ssh -R :: @`", 188 | }, 189 | { role: "user", content: "Kill a process running on port 3000." }, 190 | { role: "assistant", content: "`lsof -ti tcp:3000 | xargs kill`" }, 191 | { role: "user", content: "Backup database from a mongodb container." }, 192 | { 193 | role: "assistant", 194 | content: 195 | '`docker exec -it mongodb bash -c "mongoexport --db mongodb --collection collections --outdir backup"`', 196 | }, 197 | { role: "user", content: "SSH Tunnel Remote Host port into a local port." }, 198 | { 199 | role: "assistant", 200 | content: 201 | "`ssh -L :: @`", 202 | }, 203 | { role: "user", content: "Copy local file to S3." }, 204 | { 205 | role: "assistant", 206 | content: "`aws s3 cp s3:///`", 207 | }, 208 | { role: "user", content: "Copy S3 file to local." }, 209 | { 210 | role: "assistant", 211 | content: "`aws s3 cp s3:/// `", 212 | }, 213 | { role: "user", content: "Recursively remove a folder." }, 214 | { role: "assistant", content: "`rm -rf `" }, 215 | { role: "user", content: "Copy a file from local to ssh server." }, 216 | { 217 | role: "assistant", 218 | content: "`scp /path/to/file user@server:/path/to/destination`", 219 | }, 220 | { role: "user", content: "Curl syntax with port." }, 221 | { role: "assistant", content: "`curl http://localhost:3000`" }, 222 | { role: "user", content: "Download a file from a URL with curl." }, 223 | { role: "assistant", content: "`curl -o `" }, 224 | { role: "user", content: "Git commit with message." }, 225 | { role: "assistant", content: '`git commit -m "my commit message"`' }, 226 | { role: "user", content: "Give a user sudo permissions." }, 227 | { role: "assistant", content: "`sudo usermod -aG sudo `" }, 228 | { role: "user", content: "Check what's running on a port?" }, 229 | { role: "assistant", content: "`lsof -i tcp:`" }, 230 | { role: "user", content: "View last 5 files from history" }, 231 | { role: "assistant", content: "`history | tail -5`" }, 232 | { role: "user", content: "When was China founded?" }, 233 | { role: "assistant", content: "Sorry, Can't answer that." }, 234 | { role: "user", content: "Pass auth header with curl" }, 235 | { 236 | role: "assistant", 237 | content: '`curl -H "Authorization: Bearer " `', 238 | }, 239 | { role: "user", content: "Filter docker container with labels" }, 240 | { role: "assistant", content: '`docker ps --filter "label="`' }, 241 | { role: "user", content: "When was Abraham Lincoln born?" }, 242 | { role: "assistant", content: "Sorry, Can't answer that." }, 243 | { role: "user", content: "Get into a running kubernetes pod" }, 244 | { role: "assistant", content: "`kubectl exec -it bash`" }, 245 | { role: "user", content: "Capital city of Ukraine?" }, 246 | { role: "assistant", content: "Sorry, Can't answer that." }, 247 | ]; 248 | 249 | export const getDefaultMessages = 250 | (): OpenAI.Chat.Completions.ChatCompletionMessageParam[] => { 251 | const platform = process.platform; 252 | 253 | switch (platform) { 254 | case "win32": 255 | return getPowerShellMessages(); 256 | 257 | default: 258 | return getUnixMessages(); 259 | } 260 | }; 261 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | export {run} from '@oclif/core' 2 | -------------------------------------------------------------------------------- /src/types.ts: -------------------------------------------------------------------------------- 1 | export interface IModel { 2 | name: string; 3 | isLimitedBeta?: boolean; 4 | } 5 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "declaration": true, 4 | "importHelpers": true, 5 | "module": "Node16", 6 | "outDir": "dist", 7 | "rootDir": "src", 8 | "strict": true, 9 | "target": "es2019" 10 | }, 11 | "include": [ 12 | "src/**/*" 13 | ] 14 | } 15 | --------------------------------------------------------------------------------