API tools faq
paste
Advertisement
smeech

Entirety of Espanso help text

smeech
May 1st, 2024
80
0
Never
1
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 17.50 KB | None | 0 0
raw download clone embed print report
  1. espanso 2.2.1
  2. Federico Terzi
  3. A Privacy-first, Cross-platform Text Expander
  4.  
  5. USAGE:
  6. espanso [FLAGS] [SUBCOMMAND]
  7.  
  8. FLAGS:
  9. -h, --help Prints help information
  10. -v Sets the level of verbosity
  11. -V, --version Prints version information
  12.  
  13. OPTIONS:
  14.  
  15.  
  16. SUBCOMMANDS:
  17. cmd Send a command to the espanso daemon.
  18. edit Shortcut to open the default text editor to edit config files
  19. env-path Add or remove the 'espanso' command from the PATH
  20. help Prints this message or the help of the given subcommand(s)
  21. install Install a package
  22. log Print the daemon logs.
  23. match List and execute matches from the CLI
  24. migrate Automatically migrate legacy config files to the new v2 format.
  25. package package-management commands
  26. path Prints all the espanso directory paths to easily locate configuration and matches.
  27. restart Restart the espanso service
  28. service A collection of commands to manage the Espanso service (for example, enabling auto-start on system
  29. boot).
  30. start Start espanso as a service
  31. status Check if the espanso daemon is running or not.
  32. stop Stop espanso service
  33. uninstall Remove a package
  34. workaround A collection of workarounds to solve some common problems.
  35.  
  36.  
  37. Subcommand: cmd
  38. ===
  39. espanso-cmd
  40. Send a command to the espanso daemon.
  41.  
  42. USAGE:
  43. espanso cmd [SUBCOMMAND]
  44.  
  45. FLAGS:
  46. -h, --help Prints help information
  47. -V, --version Prints version information
  48.  
  49. SUBCOMMANDS:
  50. disable Disable expansions.
  51. enable Enable expansions.
  52. help Prints this message or the help of the given subcommand(s)
  53. search Open the Espanso's search bar.
  54. toggle Enable/Disable expansions.
  55.  
  56.  
  57. Subcommand: disable
  58. =======
  59. espanso-cmd-disable
  60. Disable expansions.
  61.  
  62. USAGE:
  63. espanso cmd disable
  64.  
  65. FLAGS:
  66. -h, --help Prints help information
  67. -V, --version Prints version information
  68.  
  69.  
  70. Subcommand: enable
  71. ======
  72. espanso-cmd-enable
  73. Enable expansions.
  74.  
  75. USAGE:
  76. espanso cmd enable
  77.  
  78. FLAGS:
  79. -h, --help Prints help information
  80. -V, --version Prints version information
  81.  
  82.  
  83. Subcommand: help
  84. ====
  85. Error: Failed to get help for espanso cmd help. Make sure the command exists and supports --help option.
  86.  
  87. Subcommand: search
  88. ======
  89. espanso-cmd-search
  90. Open the Espanso's search bar.
  91.  
  92. USAGE:
  93. espanso cmd search
  94.  
  95. FLAGS:
  96. -h, --help Prints help information
  97. -V, --version Prints version information
  98.  
  99.  
  100. Subcommand: toggle
  101. ======
  102. espanso-cmd-toggle
  103. Enable/Disable expansions.
  104.  
  105. USAGE:
  106. espanso cmd toggle
  107.  
  108. FLAGS:
  109. -h, --help Prints help information
  110. -V, --version Prints version information
  111.  
  112.  
  113. Subcommand: edit
  114. ====
  115. espanso-edit
  116. Shortcut to open the default text editor to edit config files
  117.  
  118. USAGE:
  119. espanso edit [target_file]
  120.  
  121. FLAGS:
  122. -h, --help Prints help information
  123. -V, --version Prints version information
  124.  
  125. ARGS:
  126. <target_file> Defaults to "match/base.yml", it contains the relative path of the file you want to edit,
  127. such as 'config/default.yml' or 'match/base.yml'.
  128. For convenience, you can also specify the name directly and Espanso will figure out the path.
  129. For example, specifying 'email' is equivalent to 'match/email.yml'.
  130.  
  131.  
  132. Subcommand: env-path
  133. ========
  134. espanso-env-path
  135. Add or remove the 'espanso' command from the PATH
  136.  
  137. USAGE:
  138. espanso env-path [FLAGS] [SUBCOMMAND]
  139.  
  140. FLAGS:
  141. -h, --help Prints help information
  142. --prompt macOS only:Prompt for permissions if the operation requires elevated privileges.
  143. -V, --version Prints version information
  144.  
  145. SUBCOMMANDS:
  146. help Prints this message or the help of the given subcommand(s)
  147. register Add 'espanso' command to PATH
  148. unregister Remove 'espanso' command from PATH
  149.  
  150.  
  151. Subcommand: help
  152. ====
  153. Error: Failed to get help for espanso env-path help. Make sure the command exists and supports --help option.
  154.  
  155. Subcommand: register
  156. ========
  157. espanso-env-path-register
  158. Add 'espanso' command to PATH
  159.  
  160. USAGE:
  161. espanso env-path register
  162.  
  163. FLAGS:
  164. -h, --help Prints help information
  165. -V, --version Prints version information
  166.  
  167.  
  168. Subcommand: unregister
  169. ==========
  170. espanso-env-path-unregister
  171. Remove 'espanso' command from PATH
  172.  
  173. USAGE:
  174. espanso env-path unregister
  175.  
  176. FLAGS:
  177. -h, --help Prints help information
  178. -V, --version Prints version information
  179.  
  180.  
  181. Subcommand: help
  182. ====
  183. Error: Failed to get help for espanso help. Make sure the command exists and supports --help option.
  184.  
  185. Subcommand: install
  186. =======
  187. espanso-install
  188. Install a package
  189.  
  190. USAGE:
  191. espanso install [FLAGS] [OPTIONS] [package_name]
  192.  
  193. FLAGS:
  194. -e, --external Allow installing packages from non-verified repositories.
  195. --force Overwrite the package if already installed
  196. -h, --help Prints help information
  197. --refresh-index Request a fresh copy of the Espanso Hub package index instead of using the cached version.
  198. --use-native-git If specified, espanso will use the 'git' command instead of trying direct methods.
  199.  
  200. OPTIONS:
  201. --git <git> Git repository from which espanso should install the package.
  202. --git-branch <git-branch> Force espanso to search for the package on a specific git branch
  203. --version <version> Force a particular version to be installed instead of the latest available.
  204.  
  205. ARGS:
  206. <package_name> Package name
  207.  
  208.  
  209. Subcommand: log
  210. ===
  211. espanso-log
  212. Print the daemon logs.
  213.  
  214. USAGE:
  215. espanso log
  216.  
  217. FLAGS:
  218. -h, --help Prints help information
  219. -V, --version Prints version information
  220.  
  221.  
  222. Subcommand: match
  223. =====
  224. espanso-match
  225. List and execute matches from the CLI
  226.  
  227. USAGE:
  228. espanso match [SUBCOMMAND]
  229.  
  230. FLAGS:
  231. -h, --help Prints help information
  232. -V, --version Prints version information
  233.  
  234. SUBCOMMANDS:
  235. exec Triggers the expansion of a match
  236. help Prints this message or the help of the given subcommand(s)
  237. list Print matches to standard output
  238.  
  239.  
  240. Subcommand: exec
  241. ====
  242. espanso-match-exec
  243. Triggers the expansion of a match
  244.  
  245. USAGE:
  246. espanso match exec [OPTIONS]
  247.  
  248. FLAGS:
  249. -h, --help Prints help information
  250. -V, --version Prints version information
  251.  
  252. OPTIONS:
  253. --arg <arg>... Specify also an argument for the expansion, following the --arg 'name=value' format. You
  254. can specify multiple ones.
  255. -t, --trigger <trigger> The trigger of the match to be expanded
  256.  
  257.  
  258. Subcommand: help
  259. ====
  260. Error: Failed to get help for espanso match help. Make sure the command exists and supports --help option.
  261.  
  262. Subcommand: list
  263. ====
  264. espanso-match-list
  265. Print matches to standard output
  266.  
  267. USAGE:
  268. espanso match list [FLAGS] [OPTIONS]
  269.  
  270. FLAGS:
  271. -h, --help Prints help information
  272. -j, --json Output matches to the JSON format
  273. -t, --only-triggers Print only triggers without replacement
  274. -n, --preserve-newlines Preserve newlines when printing replacements. Does nothing when using JSON format.
  275. -V, --version Prints version information
  276.  
  277. OPTIONS:
  278. --class <class> Only return matches that would be active with the given class. This is relevant if you want
  279. to list matches only active inside an app-specific config.
  280. --exec <exec> Only return matches that would be active with the given exec. This is relevant if you want to
  281. list matches only active inside an app-specific config.
  282. --title <title> Only return matches that would be active with the given title. This is relevant if you want
  283. to list matches only active inside an app-specific config.
  284.  
  285.  
  286. Subcommand: migrate
  287. =======
  288. Migrate the configuration without asking for confirmation
  289.  
  290.  
  291. Subcommand: package
  292. =======
  293. espanso-package
  294. package-management commands
  295.  
  296. USAGE:
  297. espanso package [SUBCOMMAND]
  298.  
  299. FLAGS:
  300. -h, --help Prints help information
  301. -V, --version Prints version information
  302.  
  303. SUBCOMMANDS:
  304. help Prints this message or the help of the given subcommand(s)
  305. install Install a package
  306. list List all installed packages
  307. uninstall Remove a package
  308. update Update a package. If 'all' is passed as package name, attempts to update all packages.
  309.  
  310.  
  311. Subcommand: help
  312. ====
  313. Error: Failed to get help for espanso package help. Make sure the command exists and supports --help option.
  314.  
  315. Subcommand: install
  316. =======
  317. espanso-package-install
  318. Install a package
  319.  
  320. USAGE:
  321. espanso package install [FLAGS] [OPTIONS] [package_name]
  322.  
  323. FLAGS:
  324. -e, --external Allow installing packages from non-verified repositories.
  325. --force Overwrite the package if already installed
  326. -h, --help Prints help information
  327. --refresh-index Request a fresh copy of the Espanso Hub package index instead of using the cached version.
  328. --use-native-git If specified, espanso will use the 'git' command instead of trying direct methods.
  329.  
  330. OPTIONS:
  331. --git <git> Git repository from which espanso should install the package.
  332. --git-branch <git-branch> Force espanso to search for the package on a specific git branch
  333. --version <version> Force a particular version to be installed instead of the latest available.
  334.  
  335. ARGS:
  336. <package_name> Package name
  337.  
  338.  
  339. Subcommand: list
  340. ====
  341. espanso-package-list
  342. List all installed packages
  343.  
  344. USAGE:
  345. espanso package list
  346.  
  347. FLAGS:
  348. -h, --help Prints help information
  349. -V, --version Prints version information
  350.  
  351.  
  352. Subcommand: uninstall
  353. =========
  354. espanso-package-uninstall
  355. Remove a package
  356.  
  357. USAGE:
  358. espanso package uninstall [package_name]
  359.  
  360. FLAGS:
  361. -h, --help Prints help information
  362. -V, --version Prints version information
  363.  
  364. ARGS:
  365. <package_name> Package name
  366.  
  367.  
  368. Subcommand: update
  369. ======
  370. espanso-package-update
  371. Update a package. If 'all' is passed as package name, attempts to update all packages.
  372.  
  373. USAGE:
  374. espanso package update [package_name]
  375.  
  376. FLAGS:
  377. -h, --help Prints help information
  378. -V, --version Prints version information
  379.  
  380. ARGS:
  381. <package_name> Package name
  382.  
  383.  
  384. Subcommand: path
  385. ====
  386. espanso-path
  387. Prints all the espanso directory paths to easily locate configuration and matches.
  388.  
  389. USAGE:
  390. espanso path [SUBCOMMAND]
  391.  
  392. FLAGS:
  393. -h, --help Prints help information
  394. -V, --version Prints version information
  395.  
  396. SUBCOMMANDS:
  397. base Print the default match file path.
  398. config Print the current config folder path.
  399. default Print the default configuration file path.
  400. help Prints this message or the help of the given subcommand(s)
  401. packages Print the current packages folder path.
  402. runtime Print the current runtime folder path.
  403.  
  404.  
  405. Subcommand: base
  406. ====
  407. espanso-path-base
  408. Print the default match file path.
  409.  
  410. USAGE:
  411. espanso path base
  412.  
  413. FLAGS:
  414. -h, --help Prints help information
  415. -V, --version Prints version information
  416.  
  417.  
  418. Subcommand: config
  419. ======
  420. espanso-path-config
  421. Print the current config folder path.
  422.  
  423. USAGE:
  424. espanso path config
  425.  
  426. FLAGS:
  427. -h, --help Prints help information
  428. -V, --version Prints version information
  429.  
  430.  
  431. Subcommand: default
  432. =======
  433. espanso-path-default
  434. Print the default configuration file path.
  435.  
  436. USAGE:
  437. espanso path default
  438.  
  439. FLAGS:
  440. -h, --help Prints help information
  441. -V, --version Prints version information
  442.  
  443.  
  444. Subcommand: help
  445. ====
  446. Error: Failed to get help for espanso path help. Make sure the command exists and supports --help option.
  447.  
  448. Subcommand: packages
  449. ========
  450. espanso-path-packages
  451. Print the current packages folder path.
  452.  
  453. USAGE:
  454. espanso path packages
  455.  
  456. FLAGS:
  457. -h, --help Prints help information
  458. -V, --version Prints version information
  459.  
  460.  
  461. Subcommand: runtime
  462. =======
  463. espanso-path-runtime
  464. Print the current runtime folder path.
  465.  
  466. USAGE:
  467. espanso path runtime
  468.  
  469. FLAGS:
  470. -h, --help Prints help information
  471. -V, --version Prints version information
  472.  
  473.  
  474. Subcommand: restart
  475. =======
  476. espanso-restart
  477. Restart the espanso service
  478.  
  479. USAGE:
  480. espanso restart [FLAGS]
  481.  
  482. FLAGS:
  483. -h, --help Prints help information
  484. --unmanaged Run espanso as an unmanaged service (avoid system manager)
  485. -V, --version Prints version information
  486.  
  487.  
  488. Subcommand: service
  489. =======
  490. espanso-service
  491. A collection of commands to manage the Espanso service (for example, enabling auto-start on system boot).
  492.  
  493. USAGE:
  494. espanso service [SUBCOMMAND]
  495.  
  496. FLAGS:
  497. -h, --help Prints help information
  498. -V, --version Prints version information
  499.  
  500. SUBCOMMANDS:
  501. check Check if espanso is registered as a system service
  502. help Prints this message or the help of the given subcommand(s)
  503. register Register espanso as a system service
  504. restart Restart the espanso service
  505. start Start espanso as a service
  506. status Check if the espanso daemon is running or not.
  507. stop Stop espanso service
  508. unregister Unregister espanso from system services
  509.  
  510.  
  511. Subcommand: check
  512. =====
  513. espanso-service-check
  514. Check if espanso is registered as a system service
  515.  
  516. USAGE:
  517. espanso service check
  518.  
  519. FLAGS:
  520. -h, --help Prints help information
  521. -V, --version Prints version information
  522.  
  523.  
  524. Subcommand: help
  525. ====
  526. Error: Failed to get help for espanso service help. Make sure the command exists and supports --help option.
  527.  
  528. Subcommand: register
  529. ========
  530. espanso-service-register
  531. Register espanso as a system service
  532.  
  533. USAGE:
  534. espanso service register
  535.  
  536. FLAGS:
  537. -h, --help Prints help information
  538. -V, --version Prints version information
  539.  
  540.  
  541. Subcommand: restart
  542. =======
  543. espanso-service-restart
  544. Restart the espanso service
  545.  
  546. USAGE:
  547. espanso service restart [FLAGS]
  548.  
  549. FLAGS:
  550. -h, --help Prints help information
  551. --unmanaged Run espanso as an unmanaged service (avoid system manager)
  552. -V, --version Prints version information
  553.  
  554.  
  555. Subcommand: start
  556. =====
  557. espanso-service-start
  558. Start espanso as a service
  559.  
  560. USAGE:
  561. espanso service start [FLAGS]
  562.  
  563. FLAGS:
  564. -h, --help Prints help information
  565. --unmanaged Run espanso as an unmanaged service (avoid system manager)
  566. -V, --version Prints version information
  567.  
  568.  
  569. Subcommand: status
  570. ======
  571. espanso-service-status
  572. Check if the espanso daemon is running or not.
  573.  
  574. USAGE:
  575. espanso service status
  576.  
  577. FLAGS:
  578. -h, --help Prints help information
  579. -V, --version Prints version information
  580.  
  581.  
  582. Subcommand: stop
  583. ====
  584. espanso-service-stop
  585. Stop espanso service
  586.  
  587. USAGE:
  588. espanso service stop
  589.  
  590. FLAGS:
  591. -h, --help Prints help information
  592. -V, --version Prints version information
  593.  
  594.  
  595. Subcommand: unregister
  596. ==========
  597. espanso-service-unregister
  598. Unregister espanso from system services
  599.  
  600. USAGE:
  601. espanso service unregister
  602.  
  603. FLAGS:
  604. -h, --help Prints help information
  605. -V, --version Prints version information
  606.  
  607.  
  608. Subcommand: boot).
  609. ======
  610. Error: Failed to get help for espanso boot).. Make sure the command exists and supports --help option.
  611.  
  612. Subcommand: start
  613. =====
  614. espanso-start
  615. Start espanso as a service
  616.  
  617. USAGE:
  618. espanso start [FLAGS]
  619.  
  620. FLAGS:
  621. -h, --help Prints help information
  622. --unmanaged Run espanso as an unmanaged service (avoid system manager)
  623. -V, --version Prints version information
  624.  
  625.  
  626. Subcommand: status
  627. ======
  628. espanso-status
  629. Check if the espanso daemon is running or not.
  630.  
  631. USAGE:
  632. espanso status
  633.  
  634. FLAGS:
  635. -h, --help Prints help information
  636. -V, --version Prints version information
  637.  
  638.  
  639. Subcommand: stop
  640. ====
  641. espanso-stop
  642. Stop espanso service
  643.  
  644. USAGE:
  645. espanso stop
  646.  
  647. FLAGS:
  648. -h, --help Prints help information
  649. -V, --version Prints version information
  650.  
  651.  
  652. Subcommand: uninstall
  653. =========
  654. espanso-uninstall
  655. Remove a package
  656.  
  657. USAGE:
  658. espanso uninstall [package_name]
  659.  
  660. FLAGS:
  661. -h, --help Prints help information
  662. -V, --version Prints version information
  663.  
  664. ARGS:
  665. <package_name> Package name
  666.  
  667.  
  668. Subcommand: workaround
  669. ==========
  670. espanso-workaround
  671. A collection of workarounds to solve some common problems.
  672.  
  673. USAGE:
  674. espanso workaround [SUBCOMMAND]
  675.  
  676. FLAGS:
  677. -h, --help Prints help information
  678. -V, --version Prints version information
  679.  
  680. SUBCOMMANDS:
  681. help Prints this message or the help of the given subcommand(s)
  682. secure-input Attempt to disable secure input by automating the common steps.
  683.  
  684.  
  685. Subcommand: help
  686. ====
  687. Error: Failed to get help for espanso workaround help. Make sure the command exists and supports --help option.
  688.  
  689. Subcommand: secure-input
  690. ============
  691. espanso-workaround-secure-input
  692. Attempt to disable secure input by automating the common steps.
  693.  
  694. USAGE:
  695. espanso workaround secure-input
  696.  
  697. FLAGS:
  698. -h, --help Prints help information
  699. -V, --version Prints version information
  700.  
  701.  
Advertisement
Comments
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!