├── .github
└── FUNDING.yml
├── LICENSE
├── README.org
├── dwim-shell-command.el
├── dwim-shell-commands.el
└── images
├── apple.gif
├── apple.mov
├── apple.webp
├── apple_x0.50.mov
├── blur.png
├── couldnt.png
├── diredmark.gif
├── diredmark_x0.50.mov
├── diredmark_x0.50.webp
├── history.png
├── progress.gif
├── progress.mov
├── progress.webp
├── progress_x0.50.mov
├── showme.png
├── template.png
├── togif.mov
├── togif.webp
├── togif_x0.50.gif
├── togif_x0.50.mov
├── togif_x0.50_x1.5.gif
├── togif_x0.50_x2.mov
├── togif_x1.5.gif
└── togif_x1.5.mov
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | # These are supported funding model platforms
2 |
3 | github: [xenodium]
4 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.org:
--------------------------------------------------------------------------------
1 | 👉 [[https://github.com/sponsors/xenodium][Support this work via GitHub Sponsors]]
2 |
3 | * Bring command-line utilities to your Emacs workflow
4 |
5 | Use =dwim-shell-command-on-marked-files= to define new functions that apply command-line utilities to current buffer or [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Dired.html][dired]] files.
6 |
7 | For example:
8 |
9 | #+begin_src emacs-lisp :lexical no
10 | (defun my/dwim-shell-command-convert-to-gif ()
11 | "Convert all marked videos to optimized gif(s)."
12 | (interactive)
13 | (dwim-shell-command-on-marked-files
14 | "Convert to gif"
15 | "ffmpeg -loglevel quiet -stats -y -i '<>' -pix_fmt rgb24 -r 15 '<>.gif'"
16 | :utils "ffmpeg"))
17 | #+end_src
18 |
19 | Can be applied as:
20 |
21 | #+HTML:
22 |
23 | This makes wrapping one-liners a breeze, so let's do some more...
24 |
25 | ** One-liners
26 |
27 | #+begin_src emacs-lisp :lexical no
28 | (defun my/dwim-shell-command-convert-image-to-jpg ()
29 | "Convert all marked images to jpg(s)."
30 | (interactive)
31 | (dwim-shell-command-on-marked-files
32 | "Convert to jpg"
33 | "convert -verbose '<>' '<>.jpg'"
34 | :utils "convert"))
35 |
36 | (defun my/dwim-shell-command-convert-audio-to-mp3 ()
37 | "Convert all marked audio to mp3(s)."
38 | (interactive)
39 | (dwim-shell-command-on-marked-files
40 | "Convert to mp3"
41 | "ffmpeg -stats -n -i '<>' -acodec libmp3lame '<>.mp3'"
42 | :utils "ffmpeg"))
43 |
44 | (defun dwim-shell-commands-http-serve-dir ()
45 | "HTTP serve current directory."
46 | (interactive)
47 | (dwim-shell-command-on-marked-files
48 | "HTTP serve current dir"
49 | "python3 -m http.server"
50 | :utils "python3"
51 | :focus-now t
52 | :no-progress t))
53 | #+end_src
54 |
55 | ** Multi-line scripts
56 |
57 | #+begin_src emacs-lisp :lexical no
58 | (defun dwim-shell-commands-image-view-location-in-openstreetmap ()
59 | "Open image(s) location in map/browser."
60 | (interactive)
61 | (dwim-shell-command-on-marked-files
62 | "Browse location"
63 | "lat=\"$(exiftool -csv -n -gpslatitude -gpslongitude '<>' | tail -n 1 | cut -s -d',' -f2-2)\"
64 | if [ -z \"$lat\" ]; then
65 | echo \"no latitude\"
66 | exit 1
67 | fi
68 | lon=\"$(exiftool -csv -n -gpslatitude -gpslongitude '<>' | tail -n 1 | cut -s -d',' -f3-3)\"
69 | if [ -z \"$lon\" ]; then
70 | echo \"no longitude\"
71 | exit 1
72 | fi
73 | if [[ $OSTYPE == darwin* ]]; then
74 | open \"http://www.openstreetmap.org/?mlat=${lat}&mlon=${lon}&layers=C\"
75 | else
76 | xdg-open \"http://www.openstreetmap.org/?mlat=${lat}&mlon=${lon}&layers=C\"
77 | fi"
78 | :utils "exiftool"
79 | :error-autofocus t
80 | :silent-success t))
81 | #+end_src
82 |
83 | ** Pick your language
84 |
85 | #+begin_src emacs-lisp :lexical no
86 | (defun dwim-shell-command-csv-to-json-via-python ()
87 | "Convert csv file to json (via Python)."
88 | (interactive)
89 | (dwim-shell-command-on-marked-files
90 | "Convert csv file to json (via Python)."
91 | "
92 | import csv
93 | import json
94 | text = json.dumps({ \"values\": list(csv.reader(open('<>')))})
95 | fpath = '<>.json'
96 | with open(fpath , 'w') as f:
97 | f.write(text)"
98 | :shell-util "python"
99 | :shell-args "-c"))
100 |
101 | (defun dwim-shell-command-csv-to-json-via-swift ()
102 | "Convert csv file to json (via Swift)."
103 | (interactive)
104 | (dwim-shell-command-on-marked-files
105 | "Convert csv file to json (via Swift)."
106 | "import Foundation
107 | import TabularData
108 | let filePath = \"<>\"
109 | print(\"reading \\(filePath)\")
110 | let content = try String(contentsOfFile: filePath).trimmingCharacters(in: .whitespacesAndNewlines)
111 | let parsedCSV = content.components(separatedBy: CSVWritingOptions().newline).map{
112 | $0.components(separatedBy: \",\")
113 | }
114 | let jsonEncoder = JSONEncoder()
115 | let jsonData = try jsonEncoder.encode([\"value\": parsedCSV])
116 | let json = String(data: jsonData, encoding: String.Encoding.utf8)
117 | let outURL = URL(fileURLWithPath:\"<>.json\")
118 | try json!.write(to: outURL, atomically: true, encoding: String.Encoding.utf8)
119 | print(\"wrote \\(outURL)\")"
120 | :shell-pipe "swift -"))
121 | #+end_src
122 | * Build a rich toolbox (or use mine)
123 |
124 | While you may want to build your own command toolbox over time, I've also [[#my-toolbox][shared my toolbox]] (close to 100 commands).
125 |
126 | If you create new command not found in my list, I'd love to hear about it. File an [[https://github.com/xenodium/dwim-shell-command/issues/new][issue]] or just ping me ([[https://indieweb.social/@xenodium][Mastodon]] / [[https://twitter.com/xenodium][Twitter]] / [[https://www.reddit.com/user/xenodium][Reddit]] / [[mailto:me__AT__xenodium.com][Email]]).
127 |
128 | * A =shell-command=, =async-shell-command=, and =dired-do-shell-command= alternative
129 |
130 | #+HTML:
131 |
132 | ** Run M-x =dwim-shell-command= to execute disposable [[https://en.wikipedia.org/wiki/DWIM][DWIM]] shell commands
133 | - Asynchronously.
134 | - Using noweb templates.
135 | - Automatically injecting files (from [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Dired.html][dired]] or other buffers) or kill ring.
136 | - Managing buffer focus with heuristics.
137 | - Showing progress bar.
138 | - Quick buffer exit.
139 | - More reusable history.
140 |
141 | * Which files
142 |
143 | =dwim-shell-command= determines which file(s) you want the command to operate on.
144 |
145 | If visiting a [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Dired.html][dired]] buffer, draw the marked file(s).
146 |
147 | #+HTML:
148 |
149 | If visiting a buffer with an associated file, use that.
150 |
151 | #+HTML:
152 |
153 | * noweb templates
154 |
155 | Operate on drawn files using either the following:
156 |
157 | - =<>= (file path)
158 | - =<>= (file path without extension)
159 | - =<>= (extension)
160 | - =<
>= (generate a temporary directory)
161 | - =<<*>>= (all files joined)
162 | - =<>= (clipboard)
163 |
164 | For example:
165 |
166 | With drawn files =path/to/image1.png= and =path/to/image2.png=
167 |
168 | =convert <> <>.jpg= expands to
169 |
170 | #+begin_src sh
171 | convert path/to/image1.png path/to/image1.jpg
172 | convert path/to/image2.png path/to/image2.jpg
173 | #+end_src
174 |
175 | while =ls -lh <<*>>= expands to
176 |
177 | #+begin_src sh
178 | ls -lh path/to/image1.png path/to/image2.png
179 | #+end_src
180 |
181 | * Focus
182 |
183 | =dwim-shell-command= creates a process buffer to capture command output, but neither displays nor focuses on it by default. Instead, it tries to guess what's more convenient to focus on.
184 |
185 | While the process is busy, show a spinner in the minibuffer. No focus changes.
186 |
187 | #+HTML:
188 |
189 | After process is finished:
190 |
191 | If there were any files created in the =default-directory=, jump to a [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Dired.html][dired]] buffer and move point to the new file (via [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Dired-Enter.html][dired-jump]]).
192 |
193 | [[file:images/showme.png]]
194 |
195 |
196 | If no new files were created, automatically switch focus to the process buffer and display its output.
197 |
198 | #+HTML:
199 |
200 | Note: You can prevent this automatic focus by prepending your command with whitespace.
201 |
202 | " convert '<>' '<>.jpg'"
203 |
204 | If the shell command caused any errors, offer to focus the process buffer and display its output.
205 |
206 | #+HTML:
207 |
208 | *** Easily create utilities
209 |
210 | Command-line utilities like [[https://ffmpeg.org/][ffmpeg]] can be easily integrated into Emacs flows (without the need to remember any flags or parameters) by wrapping command invocations into functions and invoking via =M-x= (or your favorite binding). Same DWIM behavior from =dwim-shell-command= is inherited.
211 |
212 | * Quick exit
213 |
214 | Process buffers are read-only and can be quickly closed by pressing =q=.
215 | * More reusable history
216 | Because of templates, command history becomes automatically reusable in other contexts.
217 |
218 | #+HTML:
219 |
220 | * Install
221 |
222 | =dwim-shell-command= is available on [[https://melpa.org/#/dwim-shell-command][MELPA]].
223 |
224 | [[https://melpa.org/#/dwim-shell-command][file:https://melpa.org/packages/dwim-shell-command.svg]]
225 |
226 | 1. Install via M-x /package-install/.
227 | 2. Require, set edit style, and add company backend:
228 |
229 | #+begin_src emacs-lisp
230 | (require 'dwim-shell-command)
231 | #+end_src
232 |
233 | Now you're ready to run
234 |
235 | M-x =dwim-shell-command=
236 |
237 | ** use-package
238 |
239 | Alternatively, can also install via [[https://github.com/jwiegley/use-package][use-package]], define your own commands and remap to =shell-command='s existing binding using something like:
240 |
241 | #+begin_src emacs-lisp :lexical no
242 | (use-package dwim-shell-command
243 | :ensure t
244 | :bind (([remap shell-command] . dwim-shell-command)
245 | :map dired-mode-map
246 | ([remap dired-do-async-shell-command] . dwim-shell-command)
247 | ([remap dired-do-shell-command] . dwim-shell-command)
248 | ([remap dired-smart-shell-command] . dwim-shell-command))
249 | :config
250 | (defun my/dwim-shell-command-convert-to-gif ()
251 | "Convert all marked videos to optimized gif(s)."
252 | (interactive)
253 | (dwim-shell-command-on-marked-files
254 | "Convert to gif"
255 | "ffmpeg -loglevel quiet -stats -y -i '<>' -pix_fmt rgb24 -r 15 '<>.gif'"
256 | :utils "ffmpeg")))
257 | #+end_src
258 | * My toolbox
259 |
260 | I'm including an optional package ([[https://github.com/xenodium/dwim-shell-command/blob/main/dwim-shell-commands.el][dwim-shell-commands.el]]), with all the command line utilities I've brought in over time. You can load this optional package via:
261 |
262 | #+begin_src emacs-lisp :lexical no
263 | (require 'dwim-shell-commands)
264 | #+end_src
265 |
266 | Note: =dwim-shell-command(s).el= gives you all commands, while =dwim-shell-command.el= provides only the building blocks.
267 |
268 | Here are all the commands I've added so far...
269 |
270 | #+BEGIN_SRC emacs-lisp :results table :colnames '("Command" "Description") :exports results
271 | (let ((rows))
272 | (mapatoms
273 | (lambda (symbol)
274 | (when (and (string-match "^dwim-shell-commands"
275 | (symbol-name symbol))
276 | (not (string-match "git-set-author-name-and-email-credentials"
277 | (symbol-name symbol)))
278 | (commandp symbol))
279 | (push `(,(symbol-name symbol)
280 | ,(car
281 | (split-string
282 | (or (documentation symbol t) "")
283 | "\n")))
284 | rows))))
285 | (seq-sort (lambda (row1 row2)
286 | (string-greaterp (seq-elt row2 0) (seq-elt row1 0)))
287 | rows))
288 | #+END_SRC
289 |
290 | #+RESULTS:
291 | | Command | Description |
292 | |--------------------------------------------------------------+---------------------------------------------------------------------------|
293 | | dwim-shell-commands-audio-to-mp3 | Convert all marked audio to mp3(s). |
294 | | dwim-shell-commands-clip-round-rect-gif | Clip gif(s) with round rectangle. |
295 | | dwim-shell-commands-clipboard-to-qr | Generate a QR code from clipboard. |
296 | | dwim-shell-commands-copy-to-desktop | Copy file to ~/Desktop. |
297 | | dwim-shell-commands-copy-to-downloads | Copy file to ~/Downloads. |
298 | | dwim-shell-commands-docx-to-pdf | Convert docx(s) to pdf (via latex). |
299 | | dwim-shell-commands-download-clipboard-stream-url | Download clipboard URL. |
300 | | dwim-shell-commands-drop-video-audio | Drop audio from all marked videos. |
301 | | dwim-shell-commands-duplicate | Duplicate file. |
302 | | dwim-shell-commands-epub-to-org | Convert epub(s) to org. |
303 | | dwim-shell-commands-external-ip | Copy external IP to kill ring. |
304 | | dwim-shell-commands-files-combined-size | Get files combined file size. |
305 | | dwim-shell-commands-gif-to-video | Convert all marked gif(s) to video(s). |
306 | | dwim-shell-commands-git-clone-clipboard-url | Clone git URL in clipboard to `default-directory'. |
307 | | dwim-shell-commands-git-clone-clipboard-url-to-downloads | Clone git URL in clipboard to "~/Downloads/". |
308 | | dwim-shell-commands-git-delete-untracked-files | Delete untracked git files in `default-directory'. |
309 | | dwim-shell-commands-git-list-untracked-files | List untracked git files in `default-directory'. |
310 | | dwim-shell-commands-http-serve-dir | HTTP serve current directory. |
311 | | dwim-shell-commands-image-add-drop-shadow | Add a drop shadow. |
312 | | dwim-shell-commands-image-apply-ios-round-corners | Apply iOS round corners to image(s). |
313 | | dwim-shell-commands-image-clear-exif-metadata | Clear EXIF metadata in image(s). |
314 | | dwim-shell-commands-image-exif-metadata | View EXIF metadata in image(s). |
315 | | dwim-shell-commands-image-horizontal-flip | Horizontally flip image(s). |
316 | | dwim-shell-commands-image-reverse-geocode-location | Reverse geocode image(s) location. |
317 | | dwim-shell-commands-image-scan-code | Scan any code (ie. qr, bar, etc) from image(s). |
318 | | dwim-shell-commands-image-to-grayscale | Convert all marked images to grayscale. |
319 | | dwim-shell-commands-image-to-icns | Convert png to icns icon. |
320 | | dwim-shell-commands-image-to-jpg | Convert all marked images to jpg(s). |
321 | | dwim-shell-commands-image-to-png | Convert all marked images to png(s). |
322 | | dwim-shell-commands-image-trim-borders | Trim image(s) border (useful for video screenshots). |
323 | | dwim-shell-commands-image-vertical-flip | Horizontally flip image(s). |
324 | | dwim-shell-commands-image-view-location-in-openstreetmap | Open image(s) location in map/browser. |
325 | | dwim-shell-commands-join-as-pdf | Join all marked images as a single pdf. |
326 | | dwim-shell-commands-join-images-horizontally | Join all marked images horizontally as a single image. |
327 | | dwim-shell-commands-join-images-vertically | Join all marked images vertically as a single image. |
328 | | dwim-shell-commands-keep-pdf-page | Keep a page from pdf. |
329 | | dwim-shell-commands-kill-gpg-agent | Kill (thus restart) gpg agent. |
330 | | dwim-shell-commands-kill-process | Select and kill process. |
331 | | dwim-shell-commands-macos-abort-recording-window | Stop recording a macOS window. |
332 | | dwim-shell-commands-macos-add-to-photos | Add to Photos.app. |
333 | | dwim-shell-commands-macos-bin-plist-to-xml | Convert binary plist to xml. |
334 | | dwim-shell-commands-macos-caffeinate | Invoke caffeinate to prevent mac from sleeping. |
335 | | dwim-shell-commands-macos-convert-to-mp4 | Convert to mov to mp4 |
336 | | dwim-shell-commands-macos-empty-trash | Empty macOS trash. |
337 | | dwim-shell-commands-macos-end-recording-window | Stop recording a macOS window. |
338 | | dwim-shell-commands-macos-install-iphone-device-ipa | Install iPhone device .ipa. |
339 | | dwim-shell-commands-macos-make-finder-alias | Make macOS Finder alias. |
340 | | dwim-shell-commands-macos-ocr-text-from-desktop-region | Select a macOS desktop area to OCR and copy recognized text to kill ring. |
341 | | dwim-shell-commands-macos-ocr-text-from-image | OCR file and copy recognized text to kill ring. |
342 | | dwim-shell-commands-macos-open-with | Open file(s) with specific external app. |
343 | | dwim-shell-commands-macos-open-with-firefox | Open file(s) in Firefox. |
344 | | dwim-shell-commands-macos-open-with-safari | Open file(s) in Safari. |
345 | | dwim-shell-commands-macos-reveal-in-finder | Reveal selected files in macOS Finder. |
346 | | dwim-shell-commands-macos-screenshot-window | Select and screenshot macOS window. |
347 | | dwim-shell-commands-macos-set-default-app | Set default app for file(s). |
348 | | dwim-shell-commands-macos-share | Share selected files from macOS. |
349 | | dwim-shell-commands-macos-start-recording-window | Select and start recording a macOS window. |
350 | | dwim-shell-commands-macos-toggle-bluetooth-device-connection | Toggle Bluetooth device connection. |
351 | | dwim-shell-commands-macos-toggle-dark-mode | Toggle macOS dark mode. |
352 | | dwim-shell-commands-macos-toggle-display-rotation | Rotate display. |
353 | | dwim-shell-commands-macos-version-and-hardware-overview-info | View macOS version and hardware overview info. |
354 | | dwim-shell-commands-make-swift-package-executable | Create a swift package executable |
355 | | dwim-shell-commands-make-swift-package-library | Create a swift package library |
356 | | dwim-shell-commands-make-transparent-png | Create a transparent png. |
357 | | dwim-shell-commands-move-to-desktop | Move file to ~/Desktop. |
358 | | dwim-shell-commands-move-to-downloads | Move file to ~/Downloads. |
359 | | dwim-shell-commands-ndjson-to-org | Convert ndjson file to org. |
360 | | dwim-shell-commands-open-clipboard-url | Open clipboard URL. Offer to stream if possible. |
361 | | dwim-shell-commands-open-externally | Open file(s) externally. |
362 | | dwim-shell-commands-optimize-gif | Convert all marked videos to optimized gif(s). |
363 | | dwim-shell-commands-pass-git-pull | Pass git pull. |
364 | | dwim-shell-commands-pdf-password-protect | Add a password to pdf(s). |
365 | | dwim-shell-commands-pdf-password-unprotect | Remove a password from pdf(s). |
366 | | dwim-shell-commands-pdf-to-txt | Convert pdf to txt. |
367 | | dwim-shell-commands-ping-google | Ping google.com. |
368 | | dwim-shell-commands-rename-all | Rename all marked file(s). |
369 | | dwim-shell-commands-reorient-image | Reorient images. |
370 | | dwim-shell-commands-resize-gif | Resize marked gif(s). |
371 | | dwim-shell-commands-resize-image-by-factor | Resize marked image(s) by factor. |
372 | | dwim-shell-commands-resize-image-in-pixels | Resize marked image(s) in pixels. |
373 | | dwim-shell-commands-resize-video | Resize marked images. |
374 | | dwim-shell-commands-set-media-artwork-image-metadata | Set image artwork metadata for media file(s). |
375 | | dwim-shell-commands-sha-256-hash-file-at-clipboard-url | Download file at clipboard URL and generate SHA-256 hash. |
376 | | dwim-shell-commands-speed-up-gif | Speeds up gif(s). |
377 | | dwim-shell-commands-speed-up-video | Speed up video(s). |
378 | | dwim-shell-commands-speed-up-video-fragment | Speed up fragment in video(s). |
379 | | dwim-shell-commands-stream-clipboard-url | Stream clipboard URL using mpv. |
380 | | dwim-shell-commands-svg-to-favicons | Convert svg to common favicons. |
381 | | dwim-shell-commands-svg-to-png | Convert all marked svg(s) to png(s). |
382 | | dwim-shell-commands-tesseract-ocr-text-from-image | Extract text from image via tesseract. |
383 | | dwim-shell-commands-unzip | Unzip all marked archives (of any kind) using `atool'. |
384 | | dwim-shell-commands-upload-to-0x0 | Upload the marked files to 0x0.st |
385 | | dwim-shell-commands-video-to-gif | Convert all marked videos to gif(s). |
386 | | dwim-shell-commands-video-to-hevc-mkv | Convert all marked videos to hevc mkv. |
387 | | dwim-shell-commands-video-to-mp3 | Convert video(s) to mp3. |
388 | | dwim-shell-commands-video-to-mp3-with-artwork | Convert video(s) to mp3 (keep frame as artwork). |
389 | | dwim-shell-commands-video-to-optimized-gif | Convert all marked videos to optimized gif(s). |
390 | | dwim-shell-commands-video-to-thumbnail | Generate a thumbnail for marked video(s). |
391 | | dwim-shell-commands-video-to-webp | Convert all marked videos to webp(s). |
392 | | dwim-shell-commands-video-trim-beginning | Drop audio from all marked videos. |
393 | | dwim-shell-commands-video-trim-end | Drop audio from all marked videos. |
394 | | dwim-shell-commands-view-sqlite-schema-diagram | View sqlite schema diagram. |
395 | | dwim-shell-commands-webp-to-gif | Convert all marked webp(s) to gif(s). |
396 | | dwim-shell-commands-webp-to-video | Convert all marked webp(s) to video(s). |
397 | | dwim-shell-commands-zip | Zip all marked files into archive.zip. |
398 | | dwim-shell-commands-zip-password-protect | Protect/encrypt zip file(s) with password. |
399 |
400 | * Evaluating elisp functions
401 |
402 | This can be done with either of the following:
403 |
404 | #+begin_src emacs-lisp :lexical no
405 | emacs --quick --batch --eval '(message "<>")'
406 | #+end_src
407 |
408 | #+begin_src emacs-lisp :lexical no
409 | emacsclient --eval '(message "<>")'
410 | #+end_src
411 |
412 | * Support this work
413 |
414 | 👉 [[https://github.com/sponsors/xenodium][Support my work via GitHub Sponsors]]
415 |
--------------------------------------------------------------------------------
/dwim-shell-command.el:
--------------------------------------------------------------------------------
1 | ;;; dwim-shell-command.el --- Shell commands with DWIM behaviour -*- lexical-binding: t; -*-
2 |
3 | ;; Copyright (C) 2022 Alvaro Ramirez https://xenodium.com
4 |
5 | ;; Author: Alvaro Ramirez
6 | ;; Package-Requires: ((emacs "28.1"))
7 | ;; URL: https://github.com/xenodium/dwim-shell-command
8 | ;; Version: 0.63.2
9 |
10 | ;; This package is free software; you can redistribute it and/or modify
11 | ;; it under the terms of the GNU General Public License as published by
12 | ;; the Free Software Foundation; either version 3, or (at your option)
13 | ;; any later version.
14 |
15 | ;; This package is distributed in the hope that it will be useful,
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 | ;; GNU General Public License for more details.
19 |
20 | ;; You should have received a copy of the GNU General Public License
21 | ;; along with GNU Emacs. If not, see .
22 |
23 | ;;; Commentary:
24 |
25 | ;; Provides `dwim-shell-command' as an opinionated DWIM alternative to
26 | ;; `shell-command'.
27 | ;;
28 | ;; Use `dwim-shell-command-on-marked-files' to create your own command
29 | ;; line utilities, invoked via M-x.
30 | ;;
31 | ;; See examples at https://github.com/xenodium/dwim-shell-command/blob/main/dwim-shell-commands.el
32 |
33 | ;;; Code:
34 |
35 | (require 'cl-lib)
36 | (require 'comint)
37 | (require 'dired)
38 | (require 'dired-aux)
39 | (require 'map)
40 | (require 'seq)
41 | (require 'simple)
42 | (require 'subr-x)
43 | (require 'view)
44 |
45 | (defcustom dwim-shell-command-prompt
46 | "DWIM shell command (<> <> <>): "
47 | "`dwim-shell-command' prompt. Modify if shorter is preferred."
48 | :type 'string
49 | :group 'dwim-shell-command)
50 |
51 | (defcustom dwim-shell-command-default-command
52 | " '<>'"
53 | "Set to nil if no default shell command wanted."
54 | :type 'string
55 | :group 'dwim-shell-command)
56 |
57 | (defcustom dwim-shell-command-buffer-name
58 | "DWIM shell command"
59 | "`dwim-shell-command' buffer name. Modify if shorter is preferred."
60 | :type 'string
61 | :group 'dwim-shell-command)
62 |
63 | (defcustom dwim-shell-command-prompt-on-error nil
64 | "If t, prompt user to focus buffer on process error.
65 | Otherwise, automatically focus buffer on process error."
66 | :type 'boolean
67 | :group 'dwim-shell-command)
68 |
69 | (defcustom dwim-shell-command-use-absolute-paths nil
70 | "If t, generate absolute paths in templates. Relative otherwise."
71 | :type 'boolean
72 | :group 'dwim-shell-command)
73 |
74 | (defcustom dwim-shell-command-shell-util nil
75 | "Shell util, for example: \"zsh\" or \"bash\".
76 | Set to nil to use `shell-file-name'."
77 | :type 'string
78 | :group 'dwim-shell-command)
79 |
80 | (defcustom dwim-shell-command-shell-args nil
81 | "Shell util, for example: '(\"-x\" \"-c\").
82 | Set to nil to use `shell-command-switch'."
83 | :type '(repeat string)
84 | :group 'dwim-shell-command)
85 |
86 | (defcustom dwim-shell-command-shell-trace nil
87 | "Attempt to add --xtrace to shell command to debug."
88 | :type 'boolean
89 | :group 'dwim-shell-command)
90 |
91 | (defcustom dwim-shell-command-done-buffer-name
92 | (lambda (name)
93 | (format "%s %s" name (propertize "done" 'face 'success)))
94 | "Function to format buffer name on success.
95 | Use `identify' to remove formatting."
96 | :type 'function
97 | :group 'dwim-shell-command)
98 |
99 | (defcustom dwim-shell-command-error-buffer-name
100 | (lambda (name)
101 | (format "%s %s" name (propertize "error" 'face 'error)))
102 | "Function to format buffer name on error.
103 | Use `identify' to remove formatting."
104 | :type 'function
105 | :group 'dwim-shell-command)
106 |
107 | (defvar dwim-shell-command--commands nil "All commands in progress.")
108 |
109 | (cl-defstruct
110 | dwim-shell-command--command
111 | "Describes a command in progress."
112 | script
113 | process
114 | name
115 | calling-buffer
116 | reporter
117 | on-completion
118 | files-before
119 | silent-success
120 | error-autofocus
121 | monitor-directory)
122 |
123 | ;;;###autoload
124 | (defun dwim-shell-command (prefix)
125 | "Execute DWIM shell command asynchronously using noweb templates.
126 |
127 | Which files
128 |
129 | `dwim-shell-command' attempts to guess which file(s) you may want
130 | the command to operate on.
131 |
132 | 1. If visiting a `dired' buffer, draw the marked file(s).
133 | 2. If visiting any other buffer with an associated file, use that.
134 |
135 | Templates
136 |
137 | Operate on drawn files using either the following:
138 |
139 | <> (file path)
140 | <> (file path without extension)
141 | <> (extension)
142 | <
> (generate a temporary directory)
143 | <<*>> (all files joined)
144 | <> (clipboard)
145 | <>, <<1n>>, or <> (for current iteration)
146 |
147 | For example:
148 |
149 | With drawn files '(\"path/to/image1.png\" \"path/to/image2.png\")
150 |
151 | \"convert '<>' '<>.jpg'\" expands to
152 |
153 | \"convert 'path/to/image1.png' 'path/to/image1.jpg'\"
154 | \"convert 'path/to/image2.png' 'path/to/image2.jpg'\"
155 |
156 | while \"ls -lh <<*>>\" expands to
157 |
158 | \"ls -lh path/to/image1.png path/to/image2.png\"
159 |
160 | Focus
161 |
162 | `dwim-shell-command' creates a process buffer to capture command
163 | output, but doesn't display or focus on it by default. Instead,
164 | it tries to guess what's more convenient to focus on.
165 |
166 | While the process is busy, show a spinner in the minibuffer. No
167 | focus changes.
168 |
169 | After process is finished:
170 |
171 | 1. If there were any files created in the `default-directory',
172 | jump to a `dired' buffer and move point to the new file (via
173 | `dired-jump').
174 |
175 | 2. If no new files were created, automatically switch focus to the
176 | process buffer and display its output.
177 |
178 | Note: You can prevent this automatic focus by prepending your
179 | command with whitespace.
180 |
181 | |
182 | V
183 | \" convert '<>' '<>.jpg'\"
184 |
185 | 3. If the shell command caused any errors, offer to focus the
186 | process buffer and display its output.
187 |
188 | Quick exit
189 |
190 | Process buffers are read-only and can be quickly closed by
191 | pressing `q'.
192 |
193 | Prefix
194 |
195 | With PREFIX, execute command that number of times."
196 | (interactive "p")
197 | (let ((script (dwim-shell-command--read-shell-command)))
198 | (dwim-shell-command-on-marked-files
199 | dwim-shell-command-buffer-name script
200 | :repeat prefix
201 | :shell-util dwim-shell-command-shell-util
202 | :shell-args dwim-shell-command-shell-args
203 | :silent-success (string-prefix-p " " script)
204 | :error-autofocus (not dwim-shell-command-prompt-on-error))))
205 |
206 | (defun dwim-shell-command--read-shell-command ()
207 | "Read a shell command from the minibuffer, using `shell-command-history'."
208 | (minibuffer-with-setup-hook
209 | (lambda ()
210 | (beginning-of-line)
211 | (setq-local minibuffer-default-add-function
212 | #'minibuffer-default-add-shell-commands))
213 | (read-from-minibuffer dwim-shell-command-prompt dwim-shell-command-default-command nil nil 'shell-command-history)))
214 |
215 | (cl-defun dwim-shell-command-on-marked-files (buffer-name script &key utils extensions shell-util shell-args shell-trace shell-pipe post-process-template on-completion repeat silent-success no-progress error-autofocus monitor-directory focus-now join-separator temp-dir)
216 | "Create DWIM utilities executing templated SCRIPT on given files.
217 |
218 | Here's a simple utility invoking SCRIPT to convert image files to jpg.
219 |
220 | (defun dwim-shell-command-convert-image-to-jpg ()
221 | \"Convert all marked images to jpg(s).\"
222 | (interactive)
223 | (dwim-shell-command-on-marked-files
224 | \"Convert to jpg\"
225 | \"convert -verbose '<>' '<>.jpg'\"
226 | :utils \"convert\"))
227 |
228 | Check `dwim-shell-command-commands.el' for more examples.
229 |
230 | All command process output is written to a buffer with BUFFER-NAME.
231 |
232 | All params explained in `dwim-shell-command-execute-script'.
233 |
234 | Which files
235 |
236 | `dwim-shell-command-on-marked-files' attempts to guess which file(s)
237 | you may want the command to operate on.
238 |
239 | 1. If visiting a `dired' buffer, draw the marked file(s).
240 | 2. If visiting any other buffer with an associated file, use that.
241 |
242 | Templates
243 |
244 | Operate on drawn files using either the following:
245 |
246 | <> (file path)
247 | <> (file path without extension)
248 | <> (extension)
249 | <
> (generate a temporary directory)
250 | <<*>> (all files joined)
251 | <> (clipboard)
252 | <>, <<1n>>, or <> (for current iteration)
253 |
254 | For example:
255 |
256 | With drawn files '(\"path/to/image1.png\" \"path/to/image2.png\")
257 |
258 | \"convert '<>' '<>.jpg'\" expands to
259 |
260 | \"convert 'path/to/image1.png' 'path/to/image1.jpg'\"
261 | \"convert 'path/to/image2.png' 'path/to/image2.jpg'\"
262 |
263 | while \"ls -lh <<*>>\" expands to
264 |
265 | \"ls -lh path/to/image1.png path/to/image2.png\"
266 |
267 | Focus
268 |
269 | `dwim-shell-command-on-marked-files' creates a process buffer to
270 | capture command output, but doesn't display or focus on it by
271 | default. Instead, it tries to guess what's more convenient to focus
272 | on.
273 |
274 | While the process is busy, show a spinner in the minibuffer. No
275 | focus changes.
276 |
277 | After process is finished:
278 |
279 | 1. If there were any files created in the `default-directory',
280 | jump to a `dired' buffer and move point to the new file (via
281 | `dired-jump').
282 |
283 | 2. If no new files were created, automatically switch focus to the
284 | process buffer and display its output.
285 |
286 | Note: You can prevent this automatic focus by prepending your
287 | command with whitespace.
288 |
289 | |
290 | V
291 | \" convert '<>' '<>.jpg'\"
292 |
293 | 3. If the shell command caused any errors, offer to focus the
294 | process buffer and display its output.
295 |
296 | Quick exit
297 |
298 | Process buffers are read-only and can be quickly closed by
299 | pressing `q'."
300 | (dwim-shell-command-execute-script buffer-name script
301 | :files (dwim-shell-command--files)
302 | :utils utils
303 | :extensions extensions
304 | :shell-util shell-util
305 | :shell-args shell-args
306 | :shell-trace shell-trace
307 | :shell-pipe shell-pipe
308 | :post-process-template post-process-template
309 | :on-completion on-completion
310 | :silent-success silent-success
311 | :no-progress no-progress
312 | :repeat repeat
313 | :error-autofocus error-autofocus
314 | :monitor-directory monitor-directory
315 | :focus-now focus-now
316 | :join-separator join-separator
317 | :temp-dir temp-dir))
318 |
319 | (cl-defun dwim-shell-command-execute-script (buffer-name script &key files extensions shell-util shell-args shell-trace shell-pipe utils post-process-template on-completion silent-success temp-dir repeat no-progress error-autofocus monitor-directory focus-now join-separator)
320 | "Execute a script asynchronously, DWIM style with SCRIPT and BUFFER-NAME.
321 |
322 | :FILES are used to instantiate SCRIPT as a noweb template.
323 |
324 | The following are supported:
325 |
326 | <> (file path)
327 | <> (file path without extension)
328 | <> (extension)
329 | <
> (generate a temporary directory)
330 | <<*>> (all files joined)
331 | <> (clipboard)
332 | <>, <<1n>>, or <> (for current iteration)
333 |
334 | For example:
335 |
336 | Given :FILES '(\"path/to/image1.png\" \"path/to/image2.png\")
337 |
338 | \"convert '<>' '<>.jpg'\" expands to
339 |
340 | \"convert 'path/to/image1.png' 'path/to/image1.jpg'\"
341 | \"convert 'path/to/image2.png' 'path/to/image2.jpg'\"
342 |
343 | and \"ls -lh <<*>>\" expands to
344 |
345 | \"ls -lh path/to/image1.png path/to/image2.png\"
346 |
347 | :EXTENSIONS ensures that all files in :FILES have the given
348 | extensions. Can be either single string \"png\" or a list '(\"png\" \"jpg\").
349 |
350 | :SHELL-UTIL and :SHELL-ARGS can be used to specify SCRIPT interpreter.
351 |
352 | For python, use:
353 |
354 | (dwim-shell-command-execute-script
355 | \"Print Pi\"
356 | \"import math
357 | print math.pi\"
358 | :shell-util \"python\"
359 | :shell-args \"-c\")
360 |
361 | :SHELL-PIPE can be used to pipe SCRIPT to it
362 |
363 | For swift, use:
364 |
365 | (dwim-shell-command-on-marked-files
366 | \"Print Pi\"
367 | \"print(Double.pi)\"
368 | :shell-pipe \"swift -\")
369 |
370 | :UTILS ensures that all needed command line utilities are installed.
371 | Can be either a single string \"ffmpeg\" or a list '(\"ffmpet\" \"convert\").
372 |
373 | :POST-PROCESS-TEMPLATE enables processing template further after noweb
374 | instantiation.
375 |
376 | :ON-COMPLETION is invoked after SCRIPT executes (disabling DWIM
377 | internal behavior).
378 |
379 | :SILENT-SUCCESS to avoid jumping to process buffer if neither error
380 | nor file generated.
381 |
382 | :TEMP-DIR to generate a temporary directory for this command.
383 | This is implied when <
> appears in the script.
384 |
385 | :REPEAT Use to repeat script N number of times.
386 |
387 | :NO-PROGRESS Suppress progress reporting.
388 |
389 | :ERROR-AUTOFOCUS Automatically focus process buffer on error.
390 |
391 | :MONITOR-DIRECTORY Monitor this directory for new files.
392 |
393 | :FOCUS-NOW Immediately focus process buffer once started."
394 | (cl-assert buffer-name nil "Script must have a buffer name")
395 | (cl-assert (not (string-empty-p script)) nil "Script must not be empty")
396 | (when (stringp extensions)
397 | (setq extensions (list extensions)))
398 | (when (and shell-util (stringp shell-util))
399 | (setq shell-util (list shell-util)))
400 | (setq shell-util (or shell-util
401 | (when shell-file-name
402 | (list shell-file-name))
403 | '("zsh")))
404 | (setq shell-args (or shell-args
405 | (when shell-command-switch
406 | (list shell-command-switch))
407 | '("-x" "-c")))
408 | (when (and shell-args (stringp shell-args))
409 | (setq shell-args (list shell-args)))
410 | ;; See if -x can be prepended.
411 | (when (and (not (seq-contains-p shell-args "-x"))
412 | (or shell-trace dwim-shell-command-shell-trace)
413 | (apply #'dwim-shell-command--program-test
414 | (seq-concatenate
415 | 'list shell-util '("-x") shell-args (list "echo"))))
416 | (setq shell-args (seq-concatenate 'list '("-x") shell-args)))
417 | (when (stringp utils)
418 | (setq utils (list utils)))
419 | (when (and (string-match-p "\<\