docs: Add profile command docs

This commit is contained in:
Noah Gorny
2021-04-18 21:53:34 +03:00
parent f78139fc05
commit df560ca04a
2 changed files with 32 additions and 0 deletions

View File

@@ -13,3 +13,4 @@ You should be familiar with them in order to fully utilize Bash-it.
search search
reload reload
doctor doctor
profile

31
docs/commands/profile.rst Normal file
View File

@@ -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