├── .github └── workflows │ └── melpazoid.yml ├── .gitignore ├── LICENSE ├── README.org └── eshell-atuin.el /.github/workflows/melpazoid.yml: -------------------------------------------------------------------------------- 1 | # melpazoid build checks. 2 | 3 | # If your package is on GitHub, enable melpazoid's checks by copying this file 4 | # to .github/workflows/melpazoid.yml and modifying RECIPE and EXIST_OK below. 5 | name: melpazoid 6 | on: [push, pull_request] 7 | 8 | jobs: 9 | build: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v3 13 | - name: Set up Python 3.10 14 | uses: actions/setup-python@v4 15 | with: 16 | python-version: '3.10' 17 | - name: Install 18 | run: | 19 | python -m pip install --upgrade pip 20 | sudo apt-get install emacs && emacs --version 21 | git clone https://github.com/riscy/melpazoid.git ~/melpazoid 22 | pip install ~/melpazoid 23 | - name: Run 24 | env: 25 | LOCAL_REPO: ${{ github.workspace }} 26 | # RECIPE is your recipe as written for MELPA: 27 | RECIPE: (eshell-atuin :repo "SqrtMinusOne/eshell-atuin" :fetcher github) 28 | # set this to false (or remove it) if the package isn't on MELPA: 29 | EXIST_OK: false 30 | run: echo $GITHUB_REF && make -C ~/melpazoid 31 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by https://www.toptal.com/developers/gitignore/api/emacs 2 | # Edit at https://www.toptal.com/developers/gitignore?templates=emacs 3 | 4 | ### Emacs ### 5 | # -*- mode: gitignore; -*- 6 | *~ 7 | \#*\# 8 | /.emacs.desktop 9 | /.emacs.desktop.lock 10 | *.elc 11 | auto-save-list 12 | tramp 13 | .\#* 14 | 15 | # Org-mode 16 | .org-id-locations 17 | *_archive 18 | 19 | # flymake-mode 20 | *_flymake.* 21 | 22 | # eshell files 23 | /eshell/history 24 | /eshell/lastdir 25 | 26 | # elpa packages 27 | /elpa/ 28 | 29 | # reftex files 30 | *.rel 31 | 32 | # AUCTeX auto folder 33 | /auto/ 34 | 35 | # cask packages 36 | .cask/ 37 | dist/ 38 | 39 | # Flycheck 40 | flycheck_*.el 41 | 42 | # server auth directory 43 | /server/ 44 | 45 | # projectiles files 46 | .projectile 47 | 48 | # directory configuration 49 | .dir-locals.el 50 | 51 | # network security 52 | /network-security.data 53 | 54 | 55 | # End of https://www.toptal.com/developers/gitignore/api/emacs 56 | -------------------------------------------------------------------------------- /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 | . -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | #+TITLE: eshell-atuin 2 | 3 | [[https://melpa.org/#/eshell-atuin][file:https://melpa.org/packages/eshell-atuin-badge.svg]] 4 | 5 | Integrate [[https://www.gnu.org/software/emacs/manual/html_mono/eshell.html][eshell]] with [[https://github.com/atuinsh/atuin][atuin]]. 6 | 7 | =atuin= stores shell history in a database, which allows for having the same history across multiple shells, sessions, and optionally across different machines. See the project page for the complete list of features. 8 | 9 | This package provides functionality to store and browse eshell history in =atuin=. 10 | 11 | * Installation 12 | The package is available on MELPA. Install it however you normally install packages, I prefer [[https://github.com/jwiegley/use-package][use-package]] and [[https://github.com/radian-software/straight.el][straight.el]]: 13 | 14 | #+begin_src emacs-lisp 15 | (use-package eshell-atuin 16 | :straight t 17 | :after eshell 18 | :config 19 | (eshell-atuin-mode)) 20 | #+end_src 21 | 22 | Alternatively, clone the repository, add it to the =load-path=, and =require= the package. 23 | 24 | If your version of =atuin= is less than 18, turn off saving command durations: 25 | #+begin_src emacs-lisp 26 | (setq eshell-atuin-save-duration nil) 27 | #+end_src 28 | 29 | * Configuration 30 | If your =atuin= binary is located in a place unknown to =executable-find=, set the =atuin-executable= variable. 31 | 32 | If you are using a vertical completion system such as [[https://github.com/abo-abo/swiper][Ivy]], [[https://github.com/radian-software/selectrum][Selectrum]], etc., you can configure the completion interface, e.g.: 33 | 34 | #+begin_src emacs-lisp 35 | (setq eshell-atuin-search-fields '(time duration command)) 36 | (setq eshell-atuin-history-format "%-160c %t + %d") 37 | #+end_src 38 | 39 | The available flags are: 40 | | Flag | atuin field (see =help atuin search=) | Required | 41 | |------+---------------------------------------+----------| 42 | | %t | =time= | *+* | 43 | | %c | =command= | *+* | 44 | | %e | =exit= | | 45 | | %d | =duration= | | 46 | | %i | =directory= | | 47 | | %u | =user= | | 48 | | %h | =host= | | 49 | | %r | =relativetime= | | 50 | 51 | See [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Custom-Format-Strings.html][(emacs) Custom Format Strings]] for information on the general =format-spec= syntax. 52 | 53 | I suspect the package might be slow if your history has a lot of records (I haven't checked yet). In this case, it might be worth setting a limit: 54 | #+begin_src emacs-lisp 55 | (setq eshell-atuin-search-options '("--exit" "0" "--limit" "10000")) 56 | #+end_src 57 | 58 | If the package ignores imported history, remove =--exit 0= from the options (see [[https://github.com/SqrtMinusOne/eshell-atuin/issues/9][#9]]). 59 | #+begin_src emacs-lisp 60 | (setq eshell-atuin-search-options nil) 61 | #+end_src 62 | 63 | * Usage 64 | Enable =eshell-atuin-mode= to turn on storing eshell commands in =atuin=. 65 | 66 | Run =eshell-atuin-history= inside an =eshell= buffer to browse the saved history. Accepting the completion will insert the command. 67 | 68 | ** Filter mode 69 | =atuin= supports 4 [[https://docs.atuin.sh/configuration/config/#filter_mode][filter modes]]: global (default), host, session, directory. Default filter mode for =eshell-atuin= can be set as follows: 70 | 71 | #+begin_src emacs-lisp 72 | (setq eshell-atuin-filter-mode 'global) 73 | #+end_src 74 | 75 | In order to switch the mode at runtime, run =M-x eshell-atuin-history= with the prefix argument: 76 | - =C-u 0 M-x eshell-atuin-history= for =global= 77 | - =C-u 1 M-x eshell-atuin-history= for =host= 78 | - =C-u 2 M-x eshell-atuin-history= for =session= 79 | - =C-u 3 M-x eshell-atuin-history= for =directory= 80 | 81 | * Implementation notes 82 | I may have overengineered the package a bit to scale on lots of records. 83 | 84 | The package caches the results of =atuin search= in =eshell-atuin--history-cache= (which see on the algorithm), and updates the cache incrementally. A formatted string for each entry is created at the moment of addition; entries are additionally "indexed" by a hashmap to lookup "raw" commands by their formatted versions. 85 | 86 | So, the only places I see with the computational complexity of O(N), where N is the number of unique commands in =atuin=, are: 87 | - populating the cache at the first run of =M-x eshell-atuin-history=; 88 | - feeding the entirety of the cache to =completing-read= on each run of =M-x eshell-atuin-history=. 89 | -------------------------------------------------------------------------------- /eshell-atuin.el: -------------------------------------------------------------------------------- 1 | ;;; eshell-atuin.el --- Integrate eshell with atuin, a shell history tool -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2024 Korytov Pavel 4 | 5 | ;; Author: Korytov Pavel 6 | ;; Maintainer: Korytov Pavel 7 | ;; Version: 0.2.0 8 | ;; Package-Requires: ((emacs "27.1") (compat "29.1.4.1")) 9 | ;; Homepage: https://github.com/SqrtMinusOne/eshell-atuin 10 | ;; Published-At: 2024-03-08 11 | 12 | ;; This file is NOT part of GNU Emacs. 13 | 14 | ;; This program is free software: you can redistribute it and/or modify 15 | ;; it under the terms of the GNU General Public License as published by 16 | ;; the Free Software Foundation, either version 3 of the License, or 17 | ;; (at your option) any later version. 18 | 19 | ;; This program is distributed in the hope that it will be useful, 20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 | ;; GNU General Public License for more details. 23 | 24 | ;; You should have received a copy of the GNU General Public License 25 | ;; along with this program. If not, see . 26 | 27 | ;;; Commentary: 28 | 29 | ;; Integrate `eshell' with atuin 30 | ;; 31 | ;; atuin stores shell history in a database, which allows for having 32 | ;; same history across multiple shells, sessions, and optionally 33 | ;; across different machines. This package provides functionality to 34 | ;; store and browse eshell history in atuin. 35 | ;; 36 | ;; `eshell-atuin-mode' and `eshell-atuin-history' are the 37 | ;; corresponding entrypoints. 38 | ;; 39 | ;; See also the package README at 40 | ;; 41 | 42 | 43 | ;;; Code: 44 | (require 'compat) 45 | (require 'em-prompt) 46 | (require 'eshell) 47 | 48 | (eval-when-compile (require 'subr-x)) 49 | 50 | (defgroup eshell-atuin () 51 | "Intergrate eshell with atuin, a shell history tool." 52 | :link '(url-link :tag "GitHub" "https://github.com/SqrtMinusOne/eshell-atuin") 53 | :group 'eshell) 54 | 55 | (defcustom eshell-atuin-executable (executable-find "atuin") 56 | "Path to the atuin executable." 57 | :group 'eshell-atuin 58 | :type 'file) 59 | 60 | (defcustom eshell-atuin-search-fields '(time duration command) 61 | "List of fields to retrive from atuin. 62 | 63 | Be sure to keep \"time\" and \"command\" here, otherwise the package 64 | will not work. 65 | 66 | \"relativetime\" will probably not work as expected." 67 | :group 'eshell-atuin 68 | :type '(repeat 69 | (choice 70 | (const time) 71 | (const exit) 72 | (const duration) 73 | (const command) 74 | (const directory) 75 | (const user) 76 | (const host) 77 | (const relativetime))) 78 | :set 79 | (lambda (sym value) 80 | (set-default sym value) 81 | (when (fboundp #'eshell-atuin--history-reset) 82 | (eshell-atuin--history-reset)))) 83 | 84 | (defcustom eshell-atuin-save-duration t 85 | "Whether to save command duration. 86 | 87 | Set to nil if your atuin version is less than 18." 88 | :group 'eshell-atuin 89 | :type 'boolean) 90 | 91 | (defcustom eshell-atuin-history-format "%c" 92 | "How to format history items. 93 | 94 | See `format-spec' on the general syntax. Available flags and 95 | corresponding search fields from `eshell-atuin-search-fields': 96 | - %t - time 97 | - %e - exit 98 | - %d - duration 99 | - %c - command 100 | - %i - directory 101 | - %u - user 102 | - %h - host 103 | - %r - relativetime" 104 | :group 'eshell-atuin 105 | :type 'file 106 | :set 107 | (lambda (sym value) 108 | (set-default sym value) 109 | (when (fboundp #'eshell-atuin--history-reset) 110 | (eshell-atuin--history-reset)))) 111 | 112 | (defcustom eshell-atuin-search-options '("--exit" "0") 113 | "Additional options for \\='atuin search\\='. 114 | 115 | See \\='atuin help search\\=' for the kind of things you may want to 116 | include here. Some examples: 117 | - \\='(\"--exit\" \"0\") to filter out non-zero exit codes. 118 | - \\='(\"--exclude-cwd\" \"/some/dir\")" 119 | :group 'eshell-atuin 120 | :type '(repeat string) 121 | :set 122 | (lambda (sym value) 123 | (set-default sym value) 124 | (when (fboundp #'eshell-atuin--history-reset) 125 | (eshell-atuin--history-reset)))) 126 | 127 | (defconst eshell-atuin-filter-modes '(global host session directory) 128 | "List of filter modes for \\='atuin search\\='.") 129 | 130 | (defcustom eshell-atuin-filter-mode nil 131 | "Default filter mode for \\'atuin search\\='." 132 | :group 'eshell-atuin 133 | :type '(choice 134 | (const nil :tag "Use default filter") 135 | (const global :tag "All hosts, all sessions, all directories") 136 | (const host :tag "History just from this host") 137 | (const session :tag "History just from this session") 138 | (const directory :tag "History just from this directory")) 139 | :set 140 | (lambda (sym value) 141 | (set-default sym value) 142 | (when (fboundp #'eshell-atuin--history-rotate-cache) 143 | (eshell-atuin--history-rotate-cache)))) 144 | 145 | (defvar-local eshell-atuin--history-id nil 146 | "Atuin ID of the current eshell command.") 147 | 148 | (defvar-local eshell-atuin--last-command-start nil 149 | "Start time the of current eshell command.") 150 | 151 | (defvar eshell-atuin--session-id nil 152 | "Current atuin session ID.") 153 | 154 | (defun eshell-atuin--bol-ignoring-prompt () 155 | (if (fboundp 'eshell-bol-ignoring-prompt) 156 | (eshell-bol-ignoring-prompt nil) 157 | (beginning-of-line))) 158 | 159 | (defun eshell-atuin--get-input () 160 | "Get eshell input string on the current line." 161 | (save-excursion 162 | (eshell-atuin--bol-ignoring-prompt) 163 | (when (looking-at-p eshell-prompt-regexp) 164 | (substring-no-properties (eshell-get-old-input))))) 165 | 166 | (defun eshell-atuin--pre-exec (&rest _args) 167 | "Tell atuin that the command has been invoked. 168 | 169 | This calls \\='atuin history start\\=', save the ID to 170 | `eshell-atuin--history-id' and time to 171 | `eshell-atuin--last-command-start'. The ID will be used to save the 172 | results of the command in `eshell-atuin--post-exec'." 173 | (when-let ((input (eshell-atuin--get-input))) 174 | (setq eshell-atuin--history-id 175 | (with-temp-buffer 176 | (with-environment-variables (("ATUIN_SESSION" eshell-atuin--session-id) 177 | ("ATUIN_HOST_NAME" 178 | (or (file-remote-p default-directory 'host) 179 | (system-name))) ) 180 | (let ((ret (call-process 181 | eshell-atuin-executable nil t nil 182 | "history" "start" "--" input))) 183 | (unless (= 0 ret) 184 | (error "`atuin history start' retured %s: %s" ret (buffer-string))) 185 | (buffer-substring-no-properties 186 | (point-min) (point-max)))))) 187 | (setq eshell-atuin--last-command-start (current-time)))) 188 | 189 | (defun eshell-atuin--post-exec () 190 | "Tell atuin that the invoked command has finished. 191 | 192 | This calls \\='atuin history end\\=' with the duration and exit code 193 | of the command." 194 | (when eshell-atuin--history-id 195 | (let* ((proc-args 196 | `(,eshell-atuin-executable 197 | "history" "end" 198 | "--exit" ,(number-to-string eshell-last-command-status) 199 | ,@(when (and eshell-atuin--last-command-start 200 | eshell-atuin-save-duration) 201 | (list 202 | "--duration" 203 | (prog1 204 | (thread-first eshell-atuin--last-command-start 205 | (time-since) 206 | (float-time) 207 | (* 1000000000) 208 | (round) 209 | (number-to-string)) 210 | (setq eshell-atuin--last-command-start nil)))) 211 | ,eshell-atuin--history-id)) 212 | (buf (generate-new-buffer "*atuin-output*")) 213 | ;; XXX No idea why `call-process' or `start-process' don't 214 | ;; work here. 215 | (proc (with-environment-variables 216 | (("ATUIN_LOG" "error") 217 | ("ATUIN_SESSION" eshell-atuin--session-id) 218 | ("ATUIN_HOST_NAME" 219 | (or (file-remote-p default-directory 'host) 220 | (system-name)))) 221 | (start-process-shell-command "atuin-history-stop" buf 222 | (string-join proc-args " "))))) 223 | (set-process-sentinel 224 | proc 225 | (lambda (process _msg) 226 | (when (eq (process-status process) 'exit) 227 | (unwind-protect 228 | (unless (= (process-exit-status process) 0) 229 | (error "`atuin history end' returned %s: %s" (process-exit-status process) 230 | (with-current-buffer buf (buffer-string)))) 231 | (kill-buffer buf)))))) 232 | (setq eshell-atuin--history-id nil))) 233 | 234 | (defun eshell-atuin--init-session () 235 | "Initialize `eshell-atuin' session, one session per Emacs." 236 | (setq eshell-atuin--session-id 237 | (string-trim 238 | (with-output-to-string 239 | (with-current-buffer standard-output 240 | (call-process eshell-atuin-executable nil t nil "uuid"))))) 241 | (setenv "ATUIN_SESSION" eshell-atuin--session-id)) 242 | 243 | ;;;###autoload 244 | (define-minor-mode eshell-atuin-mode 245 | "Store `eshell' history in atuin." 246 | :global t 247 | :group 'eshell-atuin 248 | :after-hook 249 | (progn 250 | (if eshell-atuin-mode 251 | (progn 252 | (eshell-atuin--init-session) 253 | (eshell-atuin--history-reset) 254 | (advice-add #'eshell-send-input :before #'eshell-atuin--pre-exec) 255 | (add-hook 'eshell-post-command-hook #'eshell-atuin--post-exec)) 256 | (advice-remove #'eshell-send-input #'eshell-atuin--pre-exec) 257 | (remove-hook 'eshell-post-command-hook #'eshell-atuin--post-exec)))) 258 | 259 | (defun eshell-atuin--compare (a b) 260 | "Compare two `eshell-atuin' history objects, A and B. 261 | 262 | See `eshell-atuin--history-cache' for value format." 263 | (unless (string-equal (alist-get 'command a) 264 | (alist-get 'command b)) 265 | (string-lessp 266 | (alist-get 'time a) 267 | (alist-get 'time b)))) 268 | 269 | (defvar eshell-atuin--history-cache nil 270 | "A list with shell history data from atuin. 271 | 272 | This works something like an ordered set: the list is orded by time; 273 | there's only one item for each command. 274 | 275 | One element is an alist with keys as configured in 276 | `eshell-atuin-search-fields' and values as returned by \\='atuin 277 | search\\='. That commands returns values already sorted by time and 278 | grouped by commands. 279 | 280 | The cache is used to avoid unncessary parsing of the output of the 281 | mentioned command. `eshell-atuin--history-update' sets 282 | `eshell-atuin--history-last-update' and queries atuin only for results 283 | after that time. That way, the cache is updated incrementally. 284 | 285 | New records are added as follows. 286 | 287 | `eshell-atuin--history-cache-index' is a hash table with commands as 288 | keys and pointers to this list as values. If there's already a 289 | command with the same name as the new one, it is deleted from the 290 | list via that pointer. 291 | 292 | This preserves ordering and unqiness of elements without iterating 293 | through the entire list on each update.") 294 | 295 | (defvar eshell-atuin--history-cache-index (make-hash-table :test #'equal) 296 | "An \"index\" for `eshell-atuin--history-cache'. 297 | 298 | See the variable for how it works.") 299 | 300 | (defvar eshell-atuin--history-cache-format-index (make-hash-table :test #'equal) 301 | "A hash table to map formatted commands to raw commands. 302 | 303 | The values are alists as defined in `eshell-atuin--history-cache'; the 304 | keys are formatted values, created by `eshell-atuin-history-format'. 305 | 306 | This is used to speed up the lookup after `competing-read' in 307 | `eshell-atuin-history'.") 308 | 309 | (defvar eshell-atuin--history-last-update nil 310 | "The time of update of `eshell-atuin--history-cache'.") 311 | 312 | (defvar eshell-atuin--history-cache-current-filter-mode nil 313 | "Current filter mode for `eshell-atuin--history-cache'.") 314 | 315 | (defvar eshell-atuin--history-cache-other-filter-modes nil 316 | "Values of eshell-aution cache variables for other filter modes.") 317 | 318 | (defun eshell-atuin--history-reset () 319 | "Reset `eshell-atuin' history cache." 320 | (setq eshell-atuin--history-cache nil) 321 | (setq eshell-atuin--history-last-update nil) 322 | (setq eshell-atuin--history-cache-index (make-hash-table :test #'equal)) 323 | (setq eshell-atuin--history-cache-format-index (make-hash-table :test #'equal))) 324 | 325 | (defun eshell-atuin--history-cache-p (filter-mode) 326 | "Return non-nil if atuin search with FILTER-MODE has to be cached." 327 | (or (memq filter-mode '(nil global session)) 328 | (and (eq filter-mode 'host) (null (file-remote-p default-directory 'host))))) 329 | 330 | (defun eshell-atuin--history-rotate-cache () 331 | "Rotate `eshell-atuin' history cache by filter mode. 332 | 333 | When the filter mode changes, the cache is saved and the new one is 334 | loaded, if available. 335 | 336 | If the current filter mode should not be cached, the cache is 337 | reset because the `eshell-atuin--history-collection' can only get 338 | history from the cache. Essentially, in this case the cache is reset 339 | and refilled on each invokation of `eshell-atuin-history'" 340 | (unless (eq eshell-atuin-filter-mode 341 | eshell-atuin--history-cache-current-filter-mode) 342 | ;; Save current cache, if necessary. 343 | (when (eshell-atuin--history-cache-p 344 | eshell-atuin--history-cache-current-filter-mode) 345 | (setf (alist-get eshell-atuin--history-cache-current-filter-mode 346 | eshell-atuin--history-cache-other-filter-modes) 347 | `((cache . ,eshell-atuin--history-cache) 348 | (index . ,eshell-atuin--history-cache-index) 349 | (format-index . ,eshell-atuin--history-cache-format-index) 350 | (last-update . ,eshell-atuin--history-last-update)))) 351 | ;; Load new cache, if necessary and available. 352 | (if-let ((noop (eshell-atuin--history-cache-p eshell-atuin-filter-mode)) 353 | (other-cache 354 | (alist-get eshell-atuin-filter-mode 355 | eshell-atuin--history-cache-other-filter-modes))) 356 | (let-alist other-cache 357 | (setq eshell-atuin--history-cache .cache) 358 | (setq eshell-atuin--history-cache-index .index) 359 | (setq eshell-atuin--history-cache-format-index .format-index) 360 | (setq eshell-atuin--history-last-update .last-update)) 361 | (eshell-atuin--history-reset)) 362 | (setq eshell-atuin--history-cache-current-filter-mode eshell-atuin-filter-mode)) 363 | ;; Reset cache if necessary. 364 | (unless (eshell-atuin--history-cache-p eshell-atuin-filter-mode) 365 | (eshell-atuin--history-reset))) 366 | 367 | (defun eshell-atuin--create-format-flag () 368 | "Format `eshell-atuin-search-fields' for usage in the -f flag." 369 | (mapconcat 370 | (lambda (item) 371 | (format "{%s}" item)) 372 | eshell-atuin-search-fields 373 | "\\t")) 374 | 375 | (defun eshell-atuin--parse-history-line (line) 376 | "Parse one LINE of \\='atuin search\\='. 377 | 378 | This only works for lines created with the value of the -f flag from 379 | `eshell-atuin--create-format-flag'." 380 | (let ((e (cl-loop for field in eshell-atuin-search-fields 381 | for value in (string-split line "\t") 382 | collect (cons field value)))) 383 | (when (alist-get 'command e) 384 | (setf (alist-get 'formatted-value e) 385 | (format-spec eshell-atuin-history-format 386 | `((?t . ,(alist-get 'time e "")) 387 | (?e . ,(alist-get 'exit e "")) 388 | (?d . ,(alist-get 'duration e "")) 389 | (?c . ,(alist-get 'command e "")) 390 | (?i . ,(alist-get 'directory e "")) 391 | (?h . ,(alist-get 'host e "")) 392 | (?r . ,(alist-get 'relativetime e "")))))) 393 | e)) 394 | 395 | (defun eshell-atuin--add-datum-to-cache (datum) 396 | "Add DATUM to `eshell-atuin' cache. 397 | 398 | The cache is `eshell-atuin--history-cache', which see." 399 | (when-let ((cell (gethash (alist-get 'command datum) 400 | eshell-atuin--history-cache-index))) 401 | (setf (cdr cell) (cddr cell)) 402 | (puthash (alist-get 'command (cadr cell)) 403 | cell eshell-atuin--history-cache-index)) 404 | (when (string-equal (alist-get 'command datum) 405 | (alist-get 'command (car eshell-atuin--history-cache))) 406 | (setq eshell-atuin--history-cache 407 | (cdr eshell-atuin--history-cache))) 408 | (push datum eshell-atuin--history-cache) 409 | (puthash (alist-get 'command (cadr eshell-atuin--history-cache)) 410 | eshell-atuin--history-cache 411 | eshell-atuin--history-cache-index) 412 | (puthash (alist-get 'formatted-value datum) 413 | datum 414 | eshell-atuin--history-cache-format-index)) 415 | 416 | (defun eshell-atuin--history-update () 417 | "Run \\='atuin search\\=' and update the `atuin-eshell' cache. 418 | 419 | See `eshell-atuin--history-cache' on algorithm." 420 | (with-temp-buffer 421 | (let* ((proc-args `("search" "-f" ,(eshell-atuin--create-format-flag) 422 | ,@(when eshell-atuin--history-last-update 423 | (list "--after" 424 | (thread-last 425 | eshell-atuin--history-last-update 426 | (time-since) 427 | (float-time) 428 | (round) 429 | (format "%s seconds ago")))) 430 | ,@(when eshell-atuin-filter-mode 431 | (list "--filter-mode" 432 | (symbol-name eshell-atuin-filter-mode))) 433 | ,@eshell-atuin-search-options)) 434 | (ret (with-environment-variables 435 | (("ATUIN_SESSION" eshell-atuin--session-id) 436 | ("ATUIN_HOST_NAME" (or (file-remote-p default-directory 'host) 437 | (system-name)))) 438 | (apply #'call-process eshell-atuin-executable 439 | nil t nil proc-args)))) 440 | (unless (or (= 0 ret) (= 1 ret)) 441 | (error "`atuin history list' retured %s: %s" ret (buffer-string))) 442 | (goto-char (point-min)) 443 | (cl-loop 444 | while (not (eobp)) 445 | for line = (buffer-substring-no-properties 446 | (line-beginning-position) 447 | (line-end-position)) 448 | for datum = (eshell-atuin--parse-history-line line) 449 | do (eshell-atuin--add-datum-to-cache datum) 450 | do (forward-line 1)))) 451 | (setq eshell-atuin--history-last-update (current-time))) 452 | 453 | (defun eshell-atuin--history-collection () 454 | "Return an alist with `eshell-atuin' history. 455 | 456 | The keys are formatted by `eshell-atuin-history-format'; the values 457 | are plain commands." 458 | (mapcar 459 | (lambda (e) 460 | (cons 461 | (alist-get 'formatted-value e) 462 | (alist-get 'command e))) 463 | eshell-atuin--history-cache)) 464 | 465 | (defun eshell-atuin-history (&optional arg) 466 | "Browse atuin history in Eshell. 467 | 468 | `eshell-atuin-mode' enables storing eshell history in atuin in 469 | addition to the built-in ring. `eshell-atuin-history' opens 470 | `completing-read' with the saved history, like the C-r shell binding 471 | in the original tool. 472 | 473 | ARG overrides the default filter mode (which is 474 | `eshell-atuin-filter-mode'). The value is an index of 475 | `eshell-atuin-filter-modes'. 476 | 477 | By default, the completion UI shows only commands. To change that, 478 | add more fields to `eshell-atuin-search-fields' and use them in 479 | `eshell-atuin-history-format'. The default values are such for 480 | backwards compatibility with \"non-vertical\" completion systems. 481 | 482 | The completions are ordered; the first one is the most recent one. 483 | 484 | Be sure to have the correct `eshell-prompt-regexp' set up!" 485 | (interactive "P") 486 | (let ((eshell-atuin-filter-mode 487 | (if arg 488 | (or (nth arg eshell-atuin-filter-modes) 489 | (user-error "Invalid filter mode index: %s" arg)) 490 | eshell-atuin-filter-mode))) 491 | (eshell-atuin--history-rotate-cache) 492 | (eshell-atuin--history-update)) 493 | (let* ((commands (eshell-atuin--history-collection)) 494 | (input (eshell-atuin--get-input)) 495 | (completion-table (lambda (string pred action) 496 | (if (eq action 'metadata) 497 | '(metadata (display-sort-function . identity) 498 | (cycle-sort-function . identity)) 499 | (complete-with-action 500 | action commands string pred)))) 501 | (compl (completing-read "History: " completion-table nil nil input)) 502 | (command 503 | (alist-get 'command 504 | (gethash compl eshell-atuin--history-cache-format-index)))) 505 | (eshell-bol) 506 | (delete-region (point) (line-end-position)) 507 | (insert (or command compl)))) 508 | 509 | (provide 'eshell-atuin) 510 | ;;; eshell-atuin.el ends here 511 | --------------------------------------------------------------------------------