From 6f304d63e5805f1f5fe824d6ca499260cfbd5cf0 Mon Sep 17 00:00:00 2001 From: Noah Gorny Date: Sun, 18 Apr 2021 21:53:34 +0300 Subject: [PATCH] docs: Add profile command docs --- docs/commands/index.rst | 1 + docs/commands/profile.rst | 31 +++++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 docs/commands/profile.rst diff --git a/docs/commands/index.rst b/docs/commands/index.rst index 3eee3b3ac6..3890a1392e 100644 --- a/docs/commands/index.rst +++ b/docs/commands/index.rst @@ -13,3 +13,4 @@ You should be familiar with them in order to fully utilize Bash-it. search reload doctor + profile diff --git a/docs/commands/profile.rst b/docs/commands/profile.rst new file mode 100644 index 0000000000..67ca9b5b5c --- /dev/null +++ b/docs/commands/profile.rst @@ -0,0 +1,31 @@ +.. _profile: + +Bash-it Profile +--------------- + +Have you ever wanted to port your *Bash-it* configuration into another machine? + +If you did, then ``bash-it profile`` is for you! + +This command can save and load custom *"profile"* files, that can be later +used to load and recreate your configuration, in any machine you would like |:smile:| + +When porting your configuration into a new machine, you just need to save your current profile, copy the resulting *"profile"* file, and load it in the other machine. + +Example +^^^^^^^ + +.. code-block:: bash + + # Saves your current profile + bash-it profile save my_profile + # Load the default profile, which is the one used in the default installation. + bash-it profile load default + + # Do whatever you want: + # Disable stuff + bash-it disable ... + # Enable stuff + bash-it enable ... + # If you want to get back into your original configuration, you can do it easily + bash-it profile load my_profile