commit 97fd7e7b1a7210fe703800b3ea6b81f0bfbbd2e1 Author: Alexander Khodyrev Date: Tue Aug 26 21:20:50 2025 +0300 init diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0978f4c --- /dev/null +++ b/.gitignore @@ -0,0 +1,16 @@ +.aider* +.envrc + +# Devenv +.devenv* +devenv.local.nix + +# direnv +.direnv + +# pre-commit +.pre-commit-config.yaml + +vendor/ +result +out diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/COPYING @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..9abece8 --- /dev/null +++ b/README.md @@ -0,0 +1,103 @@ +# LLM Shell Hint + +A command line tool that uses LLMs to generate shell commands based on natural language queries with a TUI interface for selection. + +The code, appropriately, was mostly generated by Aider. As was much of this README. +As always, do not run commands you don’t understand; this gives you assistance, not a liability waiver. + +## Features + +- Generate shell commands from natural language descriptions +- Interactive TUI for browsing and selecting commands +- Configurable LLM backend (OpenAI API compatible) +- Supports output to stdout or file +- Persists configuration between runs + +## Installation + +### Using Nix flakes + +```bash +# Run directly without installing +nix run github:yourusername/llm-shell-hint + +# Install permanently +nix profile install github:yourusername/llm-shell-hint +``` + +### Manual Build + +```bash +go build -o llm-shell-hint . +``` + +## Usage + +```text +Usage: llm-shell-hint [options] [query] + +Options: + -help Show help + -version Show version + -config-file Path to config file (default: ~/.config/llm-shell-hint/config.toml) + -verbose Enable debug logging + -output Path to output file (default: stdout) + -provider-url Override LLM provider URL + -api-key Override API key + -shell-type Override shell type + -model Override model name + -color-scheme Override color scheme (light/dark) +``` + +### Examples + +1. Basic query: + +```bash +llm-shell-hint "recursively find all video files ordered by size" +``` + +2. Save command to file: + +```bash +llm-shell-hint "convert all PNGs in directory to JPG" -output convert.sh +``` + +3. With debug logging: + +```bash +llm-shell-hint -verbose "backup important files to remote server" +``` + +## Configuration + +The configuration file is stored in TOML format at `~/.config/llm-shell-hint/config.toml`. + +Example configuration: + +```toml +LLMProviderURL = "https://openrouter.ai/api/v1/chat/completions" +APIKey = "your-api-key-here" +ShellType = "fish" +ModelName = "anthropic/claude-sonnet-4" +``` + +If `llm-shell-hint` cannot find a config file, it will query you for parameters, and create one. + +### Getting an API Key + +1. Sign up at [OpenRouter.ai](https://openrouter.ai/) or any other OpenAI-compatible provider +2. Get an API key from your account dashboard +3. Add it to the config file + +## Building from Source + +```bash +git clone https://github.com/yourusername/llm-shell-hint.git +cd llm-shell-hint +go build -o llm-shell-hint . +``` + +## License + +AGPLv3 diff --git a/config.go b/config.go new file mode 100644 index 0000000..eb1cd37 --- /dev/null +++ b/config.go @@ -0,0 +1,132 @@ +package main + +import ( + "bufio" + "fmt" + "os" + "path/filepath" + "strings" + + "github.com/pelletier/go-toml/v2" +) + +type Config struct { + LLMProviderURL string `toml:"LLMProviderURL"` + APIKey string `toml:"APIKey"` + ShellType string `toml:"ShellType"` + ModelName string `toml:"ModelName"` + ColorScheme string `toml:"ColorScheme"` +} + +func loadOrCreateConfig(path string) (*Config, error) { + // Check if config file exists + if _, err := os.Stat(path); os.IsNotExist(err) { + fmt.Printf("Config file %s does not exist.\n", path) + fmt.Printf("Would you like to create it? (Y/n) ") + + reader := bufio.NewReader(os.Stdin) + response, err := reader.ReadString('\n') + if err != nil { + return nil, fmt.Errorf("failed to read response: %v", err) + } + + response = strings.TrimSpace(strings.ToLower(response)) + // Default to 'y' if empty, or check for 'n' to decline + if response == "n" || response == "no" { + return nil, fmt.Errorf("config file is required") + } + + // Create config directory if it doesn't exist + configDir := filepath.Dir(path) + if err := os.MkdirAll(configDir, 0755); err != nil { + return nil, fmt.Errorf("failed to create config directory: %v", err) + } + + // Get config values from user + config, err := promptForConfig() + if err != nil { + return nil, err + } + + // Write config file + file, err := os.Create(path) + if err != nil { + return nil, fmt.Errorf("failed to create config file: %v", err) + } + defer file.Close() + + encoder := toml.NewEncoder(file) + if err := encoder.Encode(config); err != nil { + return nil, fmt.Errorf("failed to write config file: %v", err) + } + + fmt.Printf("Config file created at %s\n", path) + return config, nil + } + + // Config file exists, load it + file, err := os.Open(path) + if err != nil { + return nil, fmt.Errorf("failed to open config file: %v", err) + } + defer file.Close() + + var config Config + decoder := toml.NewDecoder(file) + if err := decoder.Decode(&config); err != nil { + return nil, fmt.Errorf("failed to parse config file: %v", err) + } + + return &config, nil +} + +func promptForConfig() (*Config, error) { + reader := bufio.NewReader(os.Stdin) + config := &Config{ + LLMProviderURL: "https://openrouter.ai/api/v1/chat/completions", + ShellType: "fish", + ModelName: "anthropic/claude-sonnet-4", + ColorScheme: "light", + } + + // Ask questions in sequence + fmt.Printf("LLM Provider URL [%s]: ", config.LLMProviderURL) + urlInput, _ := reader.ReadString('\n') + urlInput = strings.TrimSpace(urlInput) + if urlInput != "" { + config.LLMProviderURL = urlInput + } + + fmt.Print("API Key: ") + apiKey, _ := reader.ReadString('\n') + config.APIKey = strings.TrimSpace(apiKey) + if config.APIKey == "" { + return nil, fmt.Errorf("API key is required") + } + + fmt.Printf("Shell Type [%s]: ", config.ShellType) + shellInput, _ := reader.ReadString('\n') + shellInput = strings.TrimSpace(shellInput) + if shellInput != "" { + config.ShellType = shellInput + } + + fmt.Printf("Model Name [%s]: ", config.ModelName) + modelInput, _ := reader.ReadString('\n') + modelInput = strings.TrimSpace(modelInput) + if modelInput != "" { + config.ModelName = modelInput + } + + fmt.Printf("Color Scheme (light/dark) [%s]: ", config.ColorScheme) + colorInput, _ := reader.ReadString('\n') + colorInput = strings.TrimSpace(colorInput) + if colorInput == "light" || colorInput == "dark" { + config.ColorScheme = colorInput + } else if colorInput != "" { + fmt.Println("Invalid color scheme, using default (light)") + } + + return config, nil +} + diff --git a/devenv.lock b/devenv.lock new file mode 100644 index 0000000..514f40e --- /dev/null +++ b/devenv.lock @@ -0,0 +1,103 @@ +{ + "nodes": { + "devenv": { + "locked": { + "dir": "src/modules", + "lastModified": 1756048064, + "owner": "cachix", + "repo": "devenv", + "rev": "3fb20c149d329b01a2b519fbb2a9ca3e6e6e1b05", + "type": "github" + }, + "original": { + "dir": "src/modules", + "owner": "cachix", + "repo": "devenv", + "type": "github" + } + }, + "flake-compat": { + "flake": false, + "locked": { + "lastModified": 1747046372, + "owner": "edolstra", + "repo": "flake-compat", + "rev": "9100a0f413b0c601e0533d1d94ffd501ce2e7885", + "type": "github" + }, + "original": { + "owner": "edolstra", + "repo": "flake-compat", + "type": "github" + } + }, + "git-hooks": { + "inputs": { + "flake-compat": "flake-compat", + "gitignore": "gitignore", + "nixpkgs": [ + "nixpkgs" + ] + }, + "locked": { + "lastModified": 1755960406, + "owner": "cachix", + "repo": "git-hooks.nix", + "rev": "e891a93b193fcaf2fc8012d890dc7f0befe86ec2", + "type": "github" + }, + "original": { + "owner": "cachix", + "repo": "git-hooks.nix", + "type": "github" + } + }, + "gitignore": { + "inputs": { + "nixpkgs": [ + "git-hooks", + "nixpkgs" + ] + }, + "locked": { + "lastModified": 1709087332, + "owner": "hercules-ci", + "repo": "gitignore.nix", + "rev": "637db329424fd7e46cf4185293b9cc8c88c95394", + "type": "github" + }, + "original": { + "owner": "hercules-ci", + "repo": "gitignore.nix", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1755783167, + "owner": "cachix", + "repo": "devenv-nixpkgs", + "rev": "4a880fb247d24fbca57269af672e8f78935b0328", + "type": "github" + }, + "original": { + "owner": "cachix", + "ref": "rolling", + "repo": "devenv-nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "devenv": "devenv", + "git-hooks": "git-hooks", + "nixpkgs": "nixpkgs", + "pre-commit-hooks": [ + "git-hooks" + ] + } + } + }, + "root": "root", + "version": 7 +} diff --git a/devenv.nix b/devenv.nix new file mode 100644 index 0000000..58c7e69 --- /dev/null +++ b/devenv.nix @@ -0,0 +1,45 @@ +{ pkgs, lib, config, inputs, ... }: + +{ + # https://devenv.sh/basics/ + env.GREET = "devenv"; + + # https://devenv.sh/packages/ + packages = [ pkgs.git ]; + + # https://devenv.sh/languages/ + languages.go.enable = true; + + # https://devenv.sh/processes/ + # processes.cargo-watch.exec = "cargo-watch"; + + # https://devenv.sh/services/ + # services.postgres.enable = true; + + # https://devenv.sh/scripts/ + scripts.hello.exec = '' + echo hello from $GREET + ''; + + enterShell = '' + hello + git --version + ''; + + # https://devenv.sh/tasks/ + # tasks = { + # "myproj:setup".exec = "mytool build"; + # "devenv:enterShell".after = [ "myproj:setup" ]; + # }; + + # https://devenv.sh/tests/ + enterTest = '' + echo "Running tests" + git --version | grep --color=auto "${pkgs.git.version}" + ''; + + # https://devenv.sh/git-hooks/ + # git-hooks.hooks.shellcheck.enable = true; + + # See full reference at https://devenv.sh/reference/options/ +} diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..253fb2e --- /dev/null +++ b/flake.lock @@ -0,0 +1,96 @@ +{ + "nodes": { + "flake-utils": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1731533236, + "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "home-manager": { + "inputs": { + "nixpkgs": "nixpkgs" + }, + "locked": { + "lastModified": 1756022458, + "narHash": "sha256-J1i35r4HfNDdPpwL0vOBaZopQudAUVtartEerc1Jryc=", + "owner": "nix-community", + "repo": "home-manager", + "rev": "9e3a33c0bcbc25619e540b9dfea372282f8a9740", + "type": "github" + }, + "original": { + "owner": "nix-community", + "repo": "home-manager", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1755186698, + "narHash": "sha256-wNO3+Ks2jZJ4nTHMuks+cxAiVBGNuEBXsT29Bz6HASo=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "fbcf476f790d8a217c3eab4e12033dc4a0f6d23c", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "nixos-unstable", + "repo": "nixpkgs", + "type": "github" + } + }, + "nixpkgs_2": { + "locked": { + "lastModified": 1755615617, + "narHash": "sha256-HMwfAJBdrr8wXAkbGhtcby1zGFvs+StOp19xNsbqdOg=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "20075955deac2583bb12f07151c2df830ef346b4", + "type": "github" + }, + "original": { + "owner": "NixOS", + "ref": "nixos-unstable", + "repo": "nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "flake-utils": "flake-utils", + "home-manager": "home-manager", + "nixpkgs": "nixpkgs_2" + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..b6d030e --- /dev/null +++ b/flake.nix @@ -0,0 +1,94 @@ +{ + description = "Shell command helper"; + + inputs = { + nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable"; + flake-utils.url = "github:numtide/flake-utils"; + home-manager.url = "github:nix-community/home-manager"; + }; + + outputs = { self, nixpkgs, flake-utils, home-manager, ... }@inputs: + let + inherit (lib) mkEnableOption mkPackageOption mkIf; + lib = nixpkgs.lib; + in + flake-utils.lib.eachDefaultSystem (system: + let + pkgs = nixpkgs.legacyPackages.${system}; + in { + packages.default = pkgs.buildGoModule { + pname = "llm-shell-hint"; + version = "0.1.0"; + src = ./.; + vendorHash = "sha256-7sFDSzjqA6TbWpTbiyxdIGAZ4UB3MoHP/OPUQw6rdz8="; + }; + + apps.default = { + type = "app"; + program = "${self.packages.${system}.default}/bin/llm-shell-hint"; + }; + + devShells.default = pkgs.mkShell { + buildInputs = with pkgs; [ + go + nixfmt + gopls + gotools + ]; + }; + + homeManagerModules.default = { config, lib, pkgs, ... }: { + options.programs.llm-shell-hint = { + enable = lib.mkEnableOption "llm-shell-hint shell integration"; + package = lib.mkPackageOption pkgs "llm-shell-hint" { }; + enableBashIntegration = lib.mkEnableOption "Bash integration"; + enableFishIntegration = lib.mkEnableOption "Fish integration"; + enableZshIntegration = lib.mkEnableOption "Zsh integration"; + + settings = lib.mkOption { + type = with lib.types; attrsOf (oneOf [ + bool + int + float + str + (listOf str) + ]); + default = {}; + example = lib.literalExpression '' + { + LLMProviderURL = "https://openrouter.ai/api/v1/chat/completions"; + APIKey = "your-api-key"; + ShellType = "fish"; + ModelName = "anthropic/claude-sonnet-4"; + ColorScheme = "dark"; + } + ''; + description = '' + Configuration for llm-shell-hint. + ''; + }; + }; + + config = let + cfg = config.programs.llm-shell-hint; + tomlFormat = pkgs.formats.toml { }; + configFile = tomlFormat.generate "llm-shell-hint-config" cfg.settings; + in mkIf cfg.enable { + home.packages = [ cfg.package ]; + + programs.bash.initExtra = mkIf cfg.enableBashIntegration '' + ${lib.getExe cfg.package} init bash --config-file "${configFile}" | source + ''; + + programs.zsh.initExtra = mkIf cfg.enableZshIntegration '' + ${lib.getExe cfg.package} init zsh --config-file "${configFile}" | source + ''; + + programs.fish.interactiveShellInit = mkIf cfg.enableFishIntegration '' + ${lib.getExe cfg.package} init fish --config-file "${configFile}" | source + ''; + }; + }; + } + ); +} diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..63780cf --- /dev/null +++ b/go.mod @@ -0,0 +1,36 @@ +module llm-shell-hint + +go 1.24.0 + +toolchain go1.24.5 + +require ( + github.com/charmbracelet/bubbles v0.21.0 + github.com/charmbracelet/bubbletea v1.3.6 + github.com/charmbracelet/lipgloss v1.1.0 + github.com/pelletier/go-toml/v2 v2.2.4 + golang.org/x/term v0.34.0 +) + +require ( + github.com/atotto/clipboard v0.1.4 // indirect + github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect + github.com/charmbracelet/colorprofile v0.3.2 // indirect + github.com/charmbracelet/x/ansi v0.10.1 // indirect + github.com/charmbracelet/x/cellbuf v0.0.13 // indirect + github.com/charmbracelet/x/term v0.2.1 // indirect + github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f // indirect + github.com/lucasb-eyer/go-colorful v1.2.0 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + github.com/mattn/go-localereader v0.0.1 // indirect + github.com/mattn/go-runewidth v0.0.16 // indirect + github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 // indirect + github.com/muesli/cancelreader v0.2.2 // indirect + github.com/muesli/termenv v0.16.0 // indirect + github.com/rivo/uniseg v0.4.7 // indirect + github.com/sahilm/fuzzy v0.1.1 // indirect + github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect + golang.org/x/sync v0.16.0 // indirect + golang.org/x/sys v0.35.0 // indirect + golang.org/x/text v0.28.0 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..82fc071 --- /dev/null +++ b/go.sum @@ -0,0 +1,97 @@ +github.com/atotto/clipboard v0.1.4 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z4= +github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI= +github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k= +github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8= +github.com/aymanbagabas/go-udiff v0.2.0 h1:TK0fH4MteXUDspT88n8CKzvK0X9O2xu9yQjWpi6yML8= +github.com/aymanbagabas/go-udiff v0.2.0/go.mod h1:RE4Ex0qsGkTAJoQdQQCA0uG+nAzJO/pI/QwceO5fgrA= +github.com/charmbracelet/bubbles v0.21.0 h1:9TdC97SdRVg/1aaXNVWfFH3nnLAwOXr8Fn6u6mfQdFs= +github.com/charmbracelet/bubbles v0.21.0/go.mod h1:HF+v6QUR4HkEpz62dx7ym2xc71/KBHg+zKwJtMw+qtg= +github.com/charmbracelet/bubbletea v1.3.4 h1:kCg7B+jSCFPLYRA52SDZjr51kG/fMUEoPoZrkaDHyoI= +github.com/charmbracelet/bubbletea v1.3.4/go.mod h1:dtcUCyCGEX3g9tosuYiut3MXgY/Jsv9nKVdibKKRRXo= +github.com/charmbracelet/bubbletea v1.3.6 h1:VkHIxPJQeDt0aFJIsVxw8BQdh/F/L2KKZGsK6et5taU= +github.com/charmbracelet/bubbletea v1.3.6/go.mod h1:oQD9VCRQFF8KplacJLo28/jofOI2ToOfGYeFgBBxHOc= +github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc h1:4pZI35227imm7yK2bGPcfpFEmuY1gc2YSTShr4iJBfs= +github.com/charmbracelet/colorprofile v0.2.3-0.20250311203215-f60798e515dc/go.mod h1:X4/0JoqgTIPSFcRA/P6INZzIuyqdFY5rm8tb41s9okk= +github.com/charmbracelet/colorprofile v0.3.2 h1:9J27WdztfJQVAQKX2WOlSSRB+5gaKqqITmrvb1uTIiI= +github.com/charmbracelet/colorprofile v0.3.2/go.mod h1:mTD5XzNeWHj8oqHb+S1bssQb7vIHbepiebQ2kPKVKbI= +github.com/charmbracelet/lipgloss v1.1.0 h1:vYXsiLHVkK7fp74RkV7b2kq9+zDLoEU4MZoFqR/noCY= +github.com/charmbracelet/lipgloss v1.1.0/go.mod h1:/6Q8FR2o+kj8rz4Dq0zQc3vYf7X+B0binUUBwA0aL30= +github.com/charmbracelet/x/ansi v0.8.0 h1:9GTq3xq9caJW8ZrBTe0LIe2fvfLR/bYXKTx2llXn7xE= +github.com/charmbracelet/x/ansi v0.8.0/go.mod h1:wdYl/ONOLHLIVmQaxbIYEC/cRKOQyjTkowiI4blgS9Q= +github.com/charmbracelet/x/ansi v0.10.1 h1:rL3Koar5XvX0pHGfovN03f5cxLbCF2YvLeyz7D2jVDQ= +github.com/charmbracelet/x/ansi v0.10.1/go.mod h1:3RQDQ6lDnROptfpWuUVIUG64bD2g2BgntdxH0Ya5TeE= +github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd h1:vy0GVL4jeHEwG5YOXDmi86oYw2yuYUGqz6a8sLwg0X8= +github.com/charmbracelet/x/cellbuf v0.0.13-0.20250311204145-2c3ea96c31dd/go.mod h1:xe0nKWGd3eJgtqZRaN9RjMtK7xUYchjzPr7q6kcvCCs= +github.com/charmbracelet/x/cellbuf v0.0.13 h1:/KBBKHuVRbq1lYx5BzEHBAFBP8VcQzJejZ/IA3iR28k= +github.com/charmbracelet/x/cellbuf v0.0.13/go.mod h1:xe0nKWGd3eJgtqZRaN9RjMtK7xUYchjzPr7q6kcvCCs= +github.com/charmbracelet/x/exp/golden v0.0.0-20241011142426-46044092ad91 h1:payRxjMjKgx2PaCWLZ4p3ro9y97+TVLZNaRZgJwSVDQ= +github.com/charmbracelet/x/exp/golden v0.0.0-20241011142426-46044092ad91/go.mod h1:wDlXFlCrmJ8J+swcL/MnGUuYnqgQdW9rhSD61oNMb6U= +github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQaGIAQ= +github.com/charmbracelet/x/term v0.2.1/go.mod h1:oQ4enTYFV7QN4m0i9mzHrViD7TQKvNEEkHUMCmsxdUg= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f h1:Y/CXytFA4m6baUTXGLOoWe4PQhGxaX0KpnayAqC48p4= +github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f/go.mod h1:vw97MGsxSvLiUE2X8qFplwetxpGLQrlU1Q9AUEIzCaM= +github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc= +github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw= +github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY= +github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/mattn/go-localereader v0.0.1 h1:ygSAOl7ZXTx4RdPYinUpg6W99U8jWvWi9Ye2JC/oIi4= +github.com/mattn/go-localereader v0.0.1/go.mod h1:8fBrzywKY7BI3czFoHkuzRoWE9C+EiG4R1k4Cjx5p88= +github.com/mattn/go-runewidth v0.0.16 h1:E5ScNMtiwvlvB5paMFdw9p4kSQzbXFikJ5SQO6TULQc= +github.com/mattn/go-runewidth v0.0.16/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= +github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6 h1:ZK8zHtRHOkbHy6Mmr5D264iyp3TiX5OmNcI5cIARiQI= +github.com/muesli/ansi v0.0.0-20230316100256-276c6243b2f6/go.mod h1:CJlz5H+gyd6CUWT45Oy4q24RdLyn7Md9Vj2/ldJBSIo= +github.com/muesli/cancelreader v0.2.2 h1:3I4Kt4BQjOR54NavqnDogx/MIoWBFa0StPA8ELUXHmA= +github.com/muesli/cancelreader v0.2.2/go.mod h1:3XuTXfFS2VjM+HTLZY9Ak0l6eUKfijIfMUZ4EgX0QYo= +github.com/muesli/termenv v0.16.0 h1:S5AlUN9dENB57rsbnkPyfdGuWIlkmzJjbFf0Tf5FWUc= +github.com/muesli/termenv v0.16.0/go.mod h1:ZRfOIKPFDYQoDFF4Olj7/QJbW60Ol/kL1pU3VfY/Cnk= +github.com/pelletier/go-toml/v2 v2.2.2 h1:aYUidT7k73Pcl9nb2gScu7NSrKCSHIDE89b3+6Wq+LM= +github.com/pelletier/go-toml/v2 v2.2.2/go.mod h1:1t835xjRzz80PqgE6HHgN2JOsmgYu/h4qDAS4n929Rs= +github.com/pelletier/go-toml/v2 v2.2.4 h1:mye9XuhQ6gvn5h28+VilKrrPoQVanw5PMw/TB0t5Ec4= +github.com/pelletier/go-toml/v2 v2.2.4/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ= +github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/sahilm/fuzzy v0.1.1 h1:ceu5RHF8DGgoi+/dR5PsECjCDH1BE3Fnmpo7aVXOdRA= +github.com/sahilm/fuzzy v0.1.1/go.mod h1:VFvziUEIMCrT6A6tw2RFIXPXXmzXbOsSHF0DOI8ZK9Y= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= +github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA= +github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg= +github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no= +github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM= +golang.org/x/exp v0.0.0-20220909182711-5c715a9e8561 h1:MDc5xs78ZrZr3HMQugiXOAkSZtfTpbJLDr/lwfgO53E= +golang.org/x/exp v0.0.0-20220909182711-5c715a9e8561/go.mod h1:cyybsKvd6eL0RnXn6p/Grxp8F5bW7iYuBgsNCOHpMYE= +golang.org/x/sync v0.11.0 h1:GGz8+XQP4FvTTrjZPzNKTMFtSXH80RAzG+5ghFPgK9w= +golang.org/x/sync v0.11.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sync v0.16.0 h1:ycBJEhp9p4vXvUZNszeOq0kGTPghopOL8q0fq3vstxw= +golang.org/x/sync v0.16.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA= +golang.org/x/sys v0.0.0-20210809222454-d867a43fc93e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc= +golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.35.0 h1:vz1N37gP5bs89s7He8XuIYXpyY0+QlsKmzipCbUtyxI= +golang.org/x/sys v0.35.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= +golang.org/x/term v0.6.0 h1:clScbb1cHjoCkyRbWwBEUZ5H/tIFu5TAXIqaZD0Gcjw= +golang.org/x/term v0.6.0/go.mod h1:m6U89DPEgQRMq3DNkDClhWw02AUbt2daBVO4cn4Hv9U= +golang.org/x/term v0.34.0 h1:O/2T7POpk0ZZ7MAzMeWFSg6S5IpWd/RXDlM9hgM3DR4= +golang.org/x/term v0.34.0/go.mod h1:5jC53AEywhIVebHgPVeg0mj8OD3VO9OzclacVrqpaAw= +golang.org/x/text v0.3.8 h1:nAL+RVCQ9uMn3vJZbV+MRnydTJFPf8qqY42YiA6MrqY= +golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ= +golang.org/x/text v0.28.0 h1:rhazDwis8INMIwQ4tpjLDzUhx6RlXqZNPEM0huQojng= +golang.org/x/text v0.28.0/go.mod h1:U8nCwOR8jO/marOQ0QbDiOngZVEBB7MAiitBuMjXiNU= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/main.go b/main.go new file mode 100644 index 0000000..bc197bb --- /dev/null +++ b/main.go @@ -0,0 +1,464 @@ +package main + +import ( + "bytes" + "encoding/json" + "flag" + "fmt" + "io" + "log" + "net/http" + "os" + "os/user" + "path/filepath" + "strings" +) + +const version = "0.1.0" + +func buildPrompt(config *Config, query string) string { + return fmt.Sprintf(`You are a Linux shell helper. The user is asking for a shell command (in the %s dialect) to do the following task: "%s". Reply with no more than three options for a command, in Markdown codeblocks. The commands do not have to be one-liners; split lines where necessary to avoid too-long lines. Prefer splitting on pipes, start of new commands, and such places. + +You can include a short (no more than four sentences; be terse) text before each codeblock. In the text, focus on possible limitations and error modes of the command. No formatting, no introductory sentences. + +Only include options if they cover additional cases. Prefer native shell features to external commands where practical. Follow best practices. No useless cat. find should usually use the -print0 or -exec flag. Avoid commands that fail for filenames with spaces or special characters. Prefer long form of options to commands.`, config.ShellType, query) +} + +var ( + configFileFlag = flag.String("config-file", "", "Path to config file") + verboseFlag = flag.Bool("verbose", false, "Enable debug logging") + outputFileFlag = flag.String("output", "", "Path to output file (default: stdout)") + providerURLFlag = flag.String("provider-url", "", "Override LLM provider URL") + apiKeyFlag = flag.String("api-key", "", "Override API key") + shellTypeFlag = flag.String("shell-type", "", "Override shell type") + modelNameFlag = flag.String("model", "", "Override model name") + colorSchemeFlag = flag.String("color-scheme", "", "Override color scheme (light/dark)") +) + +func main() { + flag.Usage = func() { + fmt.Printf("Usage: %s [options]\n", os.Args[0]) + fmt.Println("Commands:") + fmt.Println(" query Get shell commands for a task") + fmt.Println(" init Generate shell initialization script") + fmt.Println("\nGlobal options:") + flag.PrintDefaults() + os.Exit(0) + } + + if len(os.Args) < 2 { + flag.Usage() + os.Exit(1) + } + + // First check for version/help commands before flag parsing + if len(os.Args) >= 2 { + switch os.Args[1] { + case "-v", "--version", "version": + fmt.Printf("llm-shell-hint version %s\n", version) + os.Exit(0) + case "-h", "--help", "help": + flag.Usage() + os.Exit(0) + } + } + + // Parse flags, but stop at first non-flag argument + flag.CommandLine.Parse(os.Args[1:]) + + // Get the command (first non-flag argument) + args := flag.Args() + if len(args) < 1 { + flag.Usage() + os.Exit(1) + } + + switch args[0] { + case "init": + if len(args) < 2 { + fmt.Println("Please specify shell name (e.g. fish)") + os.Exit(1) + } + + shell := args[1] + switch shell { + case "fish": + fmt.Printf(`function _llm_shell_hint + set -l LLM_SUGGESTION_FILE (mktemp) + llm-shell-hint %s --output $LLM_SUGGESTION_FILE (commandline -b) + set -l LLM_SUGGESTION (cat $LLM_SUGGESTION_FILE) + rm $LLM_SUGGESTION_FILE + + if test -n "$LLM_SUGGESTION" + commandline -r $LLM_SUGGESTION + end + + commandline -f repaint +end + +bind ctrl-q _llm_shell_hint +`, buildConfigFlags()) + + case "bash": + fmt.Printf(`_llm_shell_hint() { + local suggestion_file=$(mktemp) + llm-shell-hint %s --output "$suggestion_file" -- "$READLINE_LINE" + local suggestion=$(<"$suggestion_file") + rm "$suggestion_file" + + if [[ -n "$suggestion" ]]; then + READLINE_LINE="$suggestion" + READLINE_POINT=${#suggestion} + fi +} + +bind -x '"\C-q":_llm_shell_hint' +`, buildConfigFlags()) + + case "zsh": + fmt.Printf(`_llm_shell_hint() { + local suggestion_file=$(mktemp) + llm-shell-hint %s --output "$suggestion_file" -- "$BUFFER" + local suggestion=$(<"$suggestion_file") + rm "$suggestion_file" + + if [[ -n "$suggestion" ]]; then + BUFFER="$suggestion" + CURSOR=${#BUFFER} + fi +} + +zle -N _llm_shell_hint +bindkey '^q' _llm_shell_hint +`, buildConfigFlags()) + + default: + fmt.Printf("Unsupported shell: %s\nSupported shells: fish, bash, zsh\n", shell) + os.Exit(1) + } + os.Exit(0) + + case "query": + // Get remaining args after the command + if len(args) < 2 { + fmt.Println("Please provide a query") + os.Exit(1) + } + + query := strings.Join(args[1:], " ") + + // Determine config file path + configPath := *configFileFlag + if configPath == "" { + // Get user's home directory + usr, err := user.Current() + if err != nil { + log.Fatalf("Failed to get user home directory: %v", err) + } + configPath = filepath.Join(usr.HomeDir, ".config", "llm-shell-hint", "config.toml") + } + + // Load or create config + config, err := loadOrCreateConfig(configPath) + if err != nil { + log.Fatalf("Config error: %v", err) + } + + // Override config values with command line flags + if *providerURLFlag != "" { + config.LLMProviderURL = *providerURLFlag + } + if *apiKeyFlag != "" { + config.APIKey = *apiKeyFlag + } + if *shellTypeFlag != "" { + config.ShellType = *shellTypeFlag + } + if *modelNameFlag != "" { + config.ModelName = *modelNameFlag + } + if *colorSchemeFlag != "" { + if *colorSchemeFlag == "light" || *colorSchemeFlag == "dark" { + config.ColorScheme = *colorSchemeFlag + } else { + log.Printf("Invalid color scheme '%s', using '%s'", *colorSchemeFlag, config.ColorScheme) + } + } + + // Debug logging + if *verboseFlag { + log.Printf("[DEBUG] Config: ProviderURL=%s, ShellType=%s, ModelName=%s, APIKey=****, ColorScheme=%s", + config.LLMProviderURL, config.ShellType, config.ModelName, config.ColorScheme) + } + + // Run the TUI and get the selected command + selectedCommand, err := runTUI(config, query, *verboseFlag) + if err != nil { + log.Fatalf("Error running TUI: %v", err) + } + if selectedCommand != "" { + if *outputFileFlag != "" { + err := os.WriteFile(*outputFileFlag, []byte(selectedCommand+"\n"), 0644) + if err != nil { + log.Fatalf("Error writing to output file: %v", err) + } + } else { + fmt.Println(selectedCommand) + } + } + + case "-v", "--version", "version": + fmt.Printf("llm-shell-hint version %s\n", version) + os.Exit(0) + + case "-h", "--help", "help": + fmt.Printf("Usage: %s [options]\n", os.Args[0]) + fmt.Println("Commands:") + fmt.Println(" query Get shell commands for a task") + fmt.Println("\nUse -help with any command to see its options") + os.Exit(0) + + default: + fmt.Printf("Unknown command: %s\n", os.Args[1]) + fmt.Println("Available commands: query") + os.Exit(1) + } +} + +func queryLLM(config *Config, prompt string, verbose bool) ([]CommandWithComment, error) { + // Create HTTP request - append /chat/completions to the URL for OpenAI-compatible API + apiURL := config.LLMProviderURL + + // Debug logging + if verbose { + log.Printf("[DEBUG] Sending request to: %s", apiURL) + log.Printf("[DEBUG] Using model: %s", config.ModelName) + log.Printf("[DEBUG] API key length: %d", len(config.APIKey)) + } + + // Prepare the request payload for OpenAI-compatible API + payload := map[string]interface{}{ + "model": config.ModelName, + "messages": []map[string]interface{}{ + { + "role": "user", + "content": prompt, + }, + }, + "max_tokens": 500, + } + + jsonData, err := json.Marshal(payload) + if err != nil { + return nil, fmt.Errorf("failed to marshal JSON: %v", err) + } + + req, err := http.NewRequest("POST", apiURL, bytes.NewBuffer(jsonData)) + if err != nil { + return nil, fmt.Errorf("failed to create request: %v", err) + } + + // Set headers + req.Header.Set("Content-Type", "application/json") + req.Header.Set("Authorization", "Bearer "+config.APIKey) + // Add OpenRouter specific headers if using OpenRouter + if strings.Contains(config.LLMProviderURL, "openrouter.ai") { + req.Header.Set("HTTP-Referer", "https://github.com/your-username/llm-shell-hint") + req.Header.Set("X-Title", "LLM Shell Hint") + } + + // Send request + client := &http.Client{} + resp, err := client.Do(req) + if err != nil { + return nil, fmt.Errorf("failed to send request: %v", err) + } + defer resp.Body.Close() + + // Read response + body, err := io.ReadAll(resp.Body) + if err != nil { + return nil, fmt.Errorf("failed to read response: %v", err) + } + + // Debug logging + if verbose { + log.Printf("[DEBUG] Response status: %d", resp.StatusCode) + log.Printf("[DEBUG] Response body: %s", string(body)) + } + + // Check for non-200 status + if resp.StatusCode != http.StatusOK { + // Try to parse as JSON error first + var errorResult map[string]interface{} + if json.Unmarshal(body, &errorResult) == nil { + if errorMsg, ok := errorResult["error"].(map[string]interface{}); ok { + if message, ok := errorMsg["message"].(string); ok { + return nil, fmt.Errorf("API request failed with status %d: %s", resp.StatusCode, message) + } + } + } + // If not JSON, show the raw response (truncated if too long) + responseStr := string(body) + if len(responseStr) > 200 { + responseStr = responseStr[:200] + "..." + } + return nil, fmt.Errorf("API request failed with status %d: %s", resp.StatusCode, responseStr) + } + + // Parse response + var result map[string]interface{} + if err := json.Unmarshal(body, &result); err != nil { + // If parsing fails, show what we received (truncated) + responseStr := string(body) + if len(responseStr) > 200 { + responseStr = responseStr[:200] + "..." + } + return nil, fmt.Errorf("failed to parse response (received: %s): %v", responseStr, err) + } + + // Extract the content from the response + choices, ok := result["choices"].([]interface{}) + if !ok || len(choices) == 0 { + return nil, fmt.Errorf("invalid response format: no choices found") + } + + firstChoice, ok := choices[0].(map[string]interface{}) + if !ok { + return nil, fmt.Errorf("invalid response format: choice is not an object") + } + + message, ok := firstChoice["message"].(map[string]interface{}) + if !ok { + return nil, fmt.Errorf("invalid response format: no message found") + } + + content, ok := message["content"].(string) + if !ok { + return nil, fmt.Errorf("invalid response format: content is not a string") + } + + // Parse the content to extract commands and comments from Markdown codeblocks + commands, err := parseCommandsFromMarkdown(content) + if err != nil { + return nil, fmt.Errorf("failed to parse commands from markdown: %v", err) + } + + return commands, nil +} + +type CommandWithComment struct { + Command string + Comment string +} + +func buildConfigFlags() string { + var flags []string + if *configFileFlag != "" { + flags = append(flags, fmt.Sprintf("--config-file '%s'", *configFileFlag)) + } + if *verboseFlag { + flags = append(flags, "--verbose") + } + if *providerURLFlag != "" { + flags = append(flags, fmt.Sprintf("--provider-url '%s'", *providerURLFlag)) + } + if *apiKeyFlag != "" { + flags = append(flags, fmt.Sprintf("--api-key '%s'", *apiKeyFlag)) + } + if *shellTypeFlag != "" { + flags = append(flags, fmt.Sprintf("--shell-type '%s'", *shellTypeFlag)) + } + if *modelNameFlag != "" { + flags = append(flags, fmt.Sprintf("--model '%s'", *modelNameFlag)) + } + if *colorSchemeFlag != "" { + flags = append(flags, fmt.Sprintf("--color-scheme '%s'", *colorSchemeFlag)) + } + return strings.Join(flags, " ") +} + +func parseCommandsFromMarkdown(content string) ([]CommandWithComment, error) { + var result []CommandWithComment + + // Split content by codeblock delimiters + lines := strings.Split(content, "\n") + + var currentCommand strings.Builder + var currentComment strings.Builder + inCodeblock := false + + for _, line := range lines { + trimmedLine := strings.TrimSpace(line) + + // Check if we're entering or exiting a codeblock + if strings.HasPrefix(trimmedLine, "```") { + if inCodeblock { + // Exiting codeblock - add the command + if currentCommand.Len() > 0 { + result = append(result, CommandWithComment{ + Command: currentCommand.String(), + Comment: strings.TrimSpace(currentComment.String()), + }) + currentCommand.Reset() + currentComment.Reset() + } + inCodeblock = false + } else { + // Entering codeblock + inCodeblock = true + } + continue + } + + if inCodeblock { + currentCommand.WriteString(line) + currentCommand.WriteString("\n") + } else if trimmedLine != "" { + // Collect comment text outside codeblocks + currentComment.WriteString(line) + currentComment.WriteString(" ") + } + } + + // Handle any remaining command + if currentCommand.Len() > 0 { + result = append(result, CommandWithComment{ + Command: currentCommand.String(), + Comment: strings.TrimSpace(currentComment.String()), + }) + } + + // Clean up all commands and comments + for i := range result { + // Trim empty lines from beginning and end of command + cmdLines := strings.Split(result[i].Command, "\n") + // Trim from start + start := 0 + for start < len(cmdLines) && strings.TrimSpace(cmdLines[start]) == "" { + start++ + } + // Trim from end + end := len(cmdLines) - 1 + for end >= start && strings.TrimSpace(cmdLines[end]) == "" { + end-- + } + result[i].Command = strings.Join(cmdLines[start:end+1], "\n") + + // Trim empty lines from beginning and end of comment + commentLines := strings.Split(result[i].Comment, "\n") + // Trim from start + start = 0 + for start < len(commentLines) && strings.TrimSpace(commentLines[start]) == "" { + start++ + } + // Trim from end + end = len(commentLines) - 1 + for end >= start && strings.TrimSpace(commentLines[end]) == "" { + end-- + } + result[i].Comment = strings.Join(commentLines[start:end+1], "\n") + } + + return result, nil +} diff --git a/tui.go b/tui.go new file mode 100644 index 0000000..ac58192 --- /dev/null +++ b/tui.go @@ -0,0 +1,219 @@ +package main + +import ( + "fmt" + "os" + "strings" + + "github.com/charmbracelet/bubbles/list" + "github.com/charmbracelet/bubbles/spinner" + tea "github.com/charmbracelet/bubbletea" + "github.com/charmbracelet/lipgloss" + "golang.org/x/term" +) + +type model struct { + config *Config + query string + verbose bool + commands []CommandWithComment + loading bool + status string + err error + spinner spinner.Model + list list.Model + selectionConfirmed bool +} + +func initialModel(config *Config, query string, verbose bool) model { + sp := spinner.New() + sp.Spinner = spinner.Dot + sp.Style = lipgloss.NewStyle().Foreground(lipgloss.Color("205")) + + // Initialize list with empty items + delegate := NewWrappingDelegate() + // Set colors based on scheme + var ( + textColor = "16" // Black for light, white for dark + accentColor = "33" // Bright blue + secondaryColor = "240" // Dark gray + ) + + if config.ColorScheme == "dark" { + textColor = "15" // White + } + + delegate.Styles.SelectedTitle = lipgloss.NewStyle(). + Foreground(lipgloss.Color(textColor)). + Bold(true). + BorderLeft(true). + BorderStyle(lipgloss.NormalBorder()). + BorderForeground(lipgloss.Color(accentColor)). + PaddingLeft(1) + delegate.Styles.SelectedDesc = lipgloss.NewStyle(). + Foreground(lipgloss.Color(secondaryColor)). + BorderLeft(true). + BorderStyle(lipgloss.NormalBorder()). + BorderForeground(lipgloss.Color(accentColor)). + PaddingLeft(1) + + // Customize the delegate to wrap both commands and comments + delegate.Styles.NormalTitle = lipgloss.NewStyle(). + PaddingLeft(2) // Extra space for inactive items + + // Use full terminal width with some padding + width := 80 // Default width if we can't get terminal size + if w, _, err := term.GetSize(int(os.Stdout.Fd())); err == nil && w > 0 { + width = w - 4 // Subtract padding + } + + l := list.New([]list.Item{}, delegate, width, 20) + l.SetShowTitle(false) + l.SetShowStatusBar(false) + l.SetFilteringEnabled(false) + l.Title = "" // Set empty title + l.Styles.PaginationStyle = lipgloss.NewStyle(). + MarginLeft(4). + Foreground(lipgloss.Color("240")) // Dark gray text + l.Styles.HelpStyle = lipgloss.NewStyle(). + MarginLeft(4). + Foreground(lipgloss.Color("240")) // Dark gray text + + // Create initial model + m := model{ + config: config, + query: query, + verbose: verbose, + loading: true, + status: "Initializing...", + spinner: sp, + list: l, + } + + // Calculate maximum lines needed for commands + maxLines := 1 + for _, cmd := range m.commands { + lines := strings.Count(cmd.Command, "\n") + 1 + if lines > maxLines { + maxLines = lines + } + } + // Set height based on maximum lines, with a minimum of 3 + if maxLines < 3 { + maxLines = 3 + } + + // Update delegate height + delegate.SetHeight(maxLines) + m.list.SetDelegate(delegate) + + return m +} + +func (m model) Init() tea.Cmd { + return tea.Batch( + m.spinner.Tick, + func() tea.Msg { + m.status = "Building prompt..." + prompt := buildPrompt(m.config, m.query) + + m.status = "Querying LLM..." + commands, err := queryLLM(m.config, prompt, m.verbose) + if err != nil { + return err + } + + return commands + }, + ) +} + +func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) { + switch msg := msg.(type) { + case tea.KeyMsg: + switch msg.String() { + case "ctrl+c", "q": + return m, tea.Quit + case "enter": + if _, ok := m.list.SelectedItem().(item); ok { + m.selectionConfirmed = true + return m, tea.Quit + } + } + // Let the list handle its own key messages + var cmd tea.Cmd + m.list, cmd = m.list.Update(msg) + return m, cmd + case []CommandWithComment: + m.loading = false + m.commands = msg + // Convert commands to list items + items := make([]list.Item, len(msg)) + for i, cmd := range msg { + items[i] = item{ + command: cmd.Command, + comment: cmd.Comment, + } + } + m.list.SetItems(items) + case error: + m.err = msg + return m, tea.Quit + case spinner.TickMsg: + var cmd tea.Cmd + m.spinner, cmd = m.spinner.Update(msg) + return m, cmd + } + return m, nil +} + +// Custom list item type +type item struct { + command string + comment string +} + +func (i item) Title() string { return i.command } +func (i item) Description() string { return i.comment } +func (i item) FilterValue() string { return i.command } + +func (m model) View() string { + if m.err != nil { + return fmt.Sprintf("Error: %v\nPress q to quit", m.err) + } + + if m.loading { + return fmt.Sprintf("\n %s %s...\n", m.spinner.View(), m.status) + } + + style := lipgloss.NewStyle(). + Margin(1, 2) + + return style.Render(m.list.View()) +} + +func runTUI(config *Config, query string, verbose bool) (string, error) { + // Initialize and run the TUI + tty, err := os.OpenFile("/dev/tty", os.O_WRONLY, 0) + if err != nil { + return "", err + } + defer tty.Close() + p := tea.NewProgram(initialModel(config, query, verbose), tea.WithOutput(tty)) + + // Run the program and get the final model + finalModel, err := p.Run() + if err != nil { + return "", fmt.Errorf("error running program: %v", err) + } + + // Only print the selected command if we exited with Enter + if m, ok := finalModel.(model); ok { + if selected, ok := m.list.SelectedItem().(item); ok { + if m.selectionConfirmed { + return selected.command, nil + } + } + } + return "", nil +} diff --git a/wrapping_delegate.go b/wrapping_delegate.go new file mode 100644 index 0000000..bb37662 --- /dev/null +++ b/wrapping_delegate.go @@ -0,0 +1,164 @@ +package main + +import ( + "fmt" + "io" + + "github.com/charmbracelet/bubbles/key" + "github.com/charmbracelet/bubbles/list" + tea "github.com/charmbracelet/bubbletea" + "github.com/charmbracelet/lipgloss" +) + +// WrappingDelegate is a delegate that wraps text instead of truncating it. +// It's based on the DefaultDelegate but modified to use text wrapping. +type WrappingDelegate struct { + ShowDescription bool + Styles list.DefaultItemStyles + UpdateFunc func(tea.Msg, *list.Model) tea.Cmd + ShortHelpFunc func() []key.Binding + FullHelpFunc func() [][]key.Binding + height int + spacing int +} + +// NewWrappingDelegate creates a new delegate with wrapping behavior and default styles. +func NewWrappingDelegate() WrappingDelegate { + const defaultHeight = 2 + const defaultSpacing = 1 + return WrappingDelegate{ + ShowDescription: true, + Styles: list.NewDefaultItemStyles(), + height: defaultHeight, + spacing: defaultSpacing, + } +} + +// SetHeight sets delegate's preferred height. +func (d *WrappingDelegate) SetHeight(i int) { + d.height = i +} + +// Height returns the delegate's preferred height. +// This has effect only if ShowDescription is true, +// otherwise height is always 1. +func (d WrappingDelegate) Height() int { + if d.ShowDescription { + return d.height + } + return 1 +} + +// SetSpacing sets the delegate's spacing. +func (d *WrappingDelegate) SetSpacing(i int) { + d.spacing = i +} + +// Spacing returns the delegate's spacing. +func (d WrappingDelegate) Spacing() int { + return d.spacing +} + +// Update checks whether the delegate's UpdateFunc is set and calls it. +func (d WrappingDelegate) Update(msg tea.Msg, m *list.Model) tea.Cmd { + if d.UpdateFunc == nil { + return nil + } + return d.UpdateFunc(msg, m) +} + +// wrapText wraps text to the specified width using lipgloss +func wrapText(text string, width int, style lipgloss.Style) string { + if width <= 0 { + return text + } + return style.Width(width).Render(text) +} + +// Render prints an item with text wrapping instead of truncation. +func (d WrappingDelegate) Render(w io.Writer, m list.Model, index int, item list.Item) { + var ( + title, desc string + matchedRunes []int + s = &d.Styles + ) + + if i, ok := item.(list.DefaultItem); ok { + title = i.Title() + desc = i.Description() + } else { + return + } + + if m.Width() <= 0 { + // short-circuit + return + } + + // Calculate available text width + textwidth := m.Width() - s.NormalTitle.GetPaddingLeft() - s.NormalTitle.GetPaddingRight() + + // Conditions + var ( + isSelected = index == m.Index() + emptyFilter = m.FilterState() == list.Filtering && m.FilterValue() == "" + isFiltered = m.FilterState() == list.Filtering || m.FilterState() == list.FilterApplied + ) + + if isFiltered && index < len(m.VisibleItems()) { + // Get indices of matched characters + matchedRunes = m.MatchesForItem(index) + } + + // Apply styling and wrapping based on state + if emptyFilter { + title = wrapText(title, textwidth, s.DimmedTitle) + if d.ShowDescription { + desc = wrapText(desc, textwidth, s.DimmedDesc) + } + } else if isSelected && m.FilterState() != list.Filtering { + if isFiltered { + // Highlight matches + unmatched := s.SelectedTitle.Inline(true) + matched := unmatched.Inherit(s.FilterMatch) + title = lipgloss.StyleRunes(title, matchedRunes, matched, unmatched) + } + title = wrapText(title, textwidth, s.SelectedTitle) + if d.ShowDescription { + desc = wrapText(desc, textwidth, s.SelectedDesc) + } + } else { + if isFiltered { + // Highlight matches + unmatched := s.NormalTitle.Inline(true) + matched := unmatched.Inherit(s.FilterMatch) + title = lipgloss.StyleRunes(title, matchedRunes, matched, unmatched) + } + title = wrapText(title, textwidth, s.NormalTitle) + if d.ShowDescription { + desc = wrapText(desc, textwidth, s.NormalDesc) + } + } + + if d.ShowDescription { + fmt.Fprintf(w, "%s\n%s", title, desc) //nolint: errcheck + return + } + fmt.Fprintf(w, "%s", title) //nolint: errcheck +} + +// ShortHelp returns the delegate's short help. +func (d WrappingDelegate) ShortHelp() []key.Binding { + if d.ShortHelpFunc != nil { + return d.ShortHelpFunc() + } + return nil +} + +// FullHelp returns the delegate's full help. +func (d WrappingDelegate) FullHelp() [][]key.Binding { + if d.FullHelpFunc != nil { + return d.FullHelpFunc() + } + return nil +}