@@ -9,7 +9,7 @@ to work with.
99At the moment, we support managing and syncing of shell aliases and environment variables - with more
1010coming soon.
1111
12- The following shells are supported:
12+ The following shells are supported:
1313
1414- zsh
1515- bash
@@ -23,7 +23,7 @@ no longer need to edit your config files manually.
2323
2424Once Atuin is setup and installed, the following is required in your config file (` ~/.config/atuin/config.toml ` )
2525
26- ```
26+ ``` toml
2727[dotfiles ]
2828enabled = true
2929```
@@ -32,7 +32,7 @@ In a later release, this will be enabled by default.
3232
3333Note: If you have not yet setup sync v2, please also add
3434
35- ```
35+ ``` toml
3636[sync ]
3737records = true
3838```
@@ -43,69 +43,69 @@ to the same config file.
4343
4444## Aliases
4545
46- After creating or deleting an alias, remember to restart your shell!
46+ After creating or deleting an alias, remember to restart your shell!
4747
4848### Creating an alias
4949
50- ```
50+ ``` bash
5151atuin dotfiles alias set NAME ' COMMAND'
5252```
5353
5454For example, to alias ` k ` to be ` kubectl `
5555
5656
57- ```
57+ ``` bash
5858atuin dotfiles alias set k ' kubectl'
5959```
6060
6161or to alias ` ll ` to be ` ls -lah `
6262
63- ```
63+ ``` bash
6464atuin dotfiles alias set ll ' ls -lah'
6565```
6666
6767### Deleting an alias
6868
6969Deleting an alias is as simple as:
7070
71- ```
71+ ``` bash
7272atuin dotfiles alias delete NAME
7373```
7474
7575For example, to delete the above alias ` k ` :
7676
77- ```
77+ ``` bash
7878atuin dotfiles alias delete k
7979```
8080
8181### Listing aliases
8282
8383You can list all aliases with:
8484
85- ```
85+ ``` bash
8686atuin dotfiles alias list
8787```
8888
8989## Env vars
9090
91- After creating or deleting an env var, remember to restart your shell!
91+ After creating or deleting an env var, remember to restart your shell!
9292
93- ### Creating a var
93+ ### Creating a var
9494
95- ```
95+ ``` bash
9696atuin dotfiles var set NAME ' value'
9797```
9898
9999For example, to set ` FOO ` to be ` bar `
100100
101101
102- ```
102+ ``` bash
103103atuin dotfiles var set FOO ' bar'
104104```
105105
106106Vars are exported by default, but you can create a shell var like so
107107
108- ```
108+ ``` bash
109109atuin dotfiles var set -n foo ' bar'
110110```
111111
@@ -114,28 +114,28 @@ atuin dotfiles var set -n foo 'bar'
114114
115115Deleting a var is as simple as:
116116
117- ```
117+ ``` bash
118118atuin dotfiles var delete NAME
119119```
120120
121121For example, to delete the above var ` FOO ` :
122122
123- ```
123+ ``` bash
124124atuin dotfiles var delete FOO
125125```
126126
127127### Listing vars
128128
129129You can list all vars with:
130130
131- ```
131+ ``` bash
132132atuin dotfiles var list
133133```
134134
135135## Syncing and backing up dotfiles
136- If you have [ setup sync] ( /guide/sync ) , then running
136+ If you have [ setup sync] ( /guide/sync ) , then running
137137
138- ```
138+ ``` bash
139139atuin sync
140140```
141141
0 commit comments