Skip to content

Latest commit

 

History

History
333 lines (199 loc) · 9.39 KB

XETA_CLI.md

File metadata and controls

333 lines (199 loc) · 9.39 KB

XETA CLI v1.0.0

Available commands as of version 1.0.0

Utility commands

Utility functions used by the cli.

xeta::confirm

  • If supplied a question it will ask it and read the answer

xeta::log

  • Writes to the log file in logs/

User facing commands

Commands available for the user to use.

xeta

  • If called with no follow up commands it defaults to xeta::help.

xeta::help

  • Prints help information such as available commands.

xeta::credits

  • Prints credit and thanks to the authors of the technologies used in this project.

xeta::version

  • Returns the current version of Xeta

xeta::reload

  • Reloads the current Zsh session inturn reloads Xeta

xeta::update

  • Checks for the latest version of Xeta and updates or not accordingly

xeta::backup

  • Creates and archives a copy of Xeta and its current configuration.

xeta::uninstall

  • Uninstalls Xeta and optionally makes a backup

xeta::changelog

  • Displays and saves the latest changes on the current branch.

xeta::pr

  • If called with no follow up commands it prints a usage message

xeta::pr::clean

  • Deletes any existing pull request branches

xeta::pr::test

  • Test a pull request and optionally roll back changes

xeta::plugin

  • If called with no follow up commands it prints a usage message

xeta::plugin::disable

  • Disables a plugin(s) by removing it from the plugins array in xeta.conf

xeta::plugin::enable

  • Eables a plugin(s) by adding it to the plugins array in xeta.conf

xeta::plugin::info

  • Prints information about the specified plugin

xeta::plugin::list

  • Lists all available plugins

xeta::plugin::load

  • Loads the specified plugin(s) functions and completions

xeta::plugin::path

  • Returns the absolute path to the plugin

xeta::plugin::remove

  • Permanently deletes a plugin(s) and removes it from the plugins array in xeta.conf

xeta::plugin::update (TODO: implement)

  • Downloads updates a plugin(s) if there are any updates available

xeta::theme

  • If called with no follow up commands it prints a usage message

xeta::theme::list

  • List all available themes

xeta::theme::preview

  • Preview a single specified theme

xeta::theme::previews

  • Print a preview of all themes to the command line.

xeta::theme::set

  • Set a theme to remain persistant in your Xeta configuration file (xeta.conf)

xeta::theme::use

  • Use a theme just for the current session

xeta::theme::fav

  • Add a favorite theme to your favorites list (theme-favlist.conf)

xeta::theme::unfav

  • Remove a favorite theme from your favorites list (theme-favlist.conf)

xeta::theme::lsfav

  • List all themes in your favorites list (theme-favlist.conf)

xeta::aliases

  • If called with no follow up commands it prints a usage message

xeta::aliases::list

  • List all defined aliases

xeta::aliases::add

  • Add an alias to aliases.conf

xeta::aliases::remove

  • Remove an alias from the current session and from aliases.conf

xeta::aliases::cmd_for

  • Get the corresponding command for a specified alias name

xeta::aliases::name_for

  • Get the corresponding alias name for a specified command

xeta::aliases::containing

  • Returns aliases containing the given word or command

xeta::util

  • If called with no follow up commands it prints a usage message

xeta::util::extract

  • Extract over 10 different archive file types

xeta::edit

  • If called with no follow up commands it prints a usage message

xeta::edit::zshrc

  • Edit your Zsh configuration file (.zshrc)

xeta::edit::bashrc

  • Edit your Bash configuration file (.bashrc)

xeta::edit::favs

  • Edit the favlist configuration file (theme-favlist.conf)

xeta::edit::config

  • Edit the Xeta configuration file (xeta.conf)

xeta::edit::aliases

  • Edit the aliases configuration file (aliases.conf)

xeta::edit::globals

  • Edit the globals configuration file (globals.conf)

xeta::edit::keybinds

  • Edit the key-binds configuration file (key-binds.conf)

xeta::edit::jumppoints

  • Edit the jump-points configuration file (jump-points.conf)

xeta::edit::path

  • Edit the path configuration file (path.conf)

xeta::stats

  • If called with no follow up commands it prints a usage message

xeta::stats::cmds

  • Prints stats on the top 20 most used commands

xeta::git

  • If called with no follow up commands it prints a usage message

xeta::git::status

  • Print the status of the currnt repository

xeta::git::commit

  • If called with no follow up commands it prints a usage message

xeta::git::commit::all

  • Commit all changes to the current branch

xeta::git::commit::specific (TODO: implement)

  • Commit specific changes to te current branch

xeta::user (TODO: implement)

  • If called with no follow up commands it prints a usage message

xeta::user::pin (TODO: implement)

  • If called with no follow up commands it prints the usage message

xeta::user::pin::reset

  • Resets your pin

xeta::toggle

  • If called with no follow up commands it prints a usage message

xeta::toggle::sudo (TODO: implement)

  • Activate/Deactivate automatic sudo commands via $SUDO in xeta.conf