myriation/atuin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix: many wins were broken 📝 (#789)

Browse source
This commit is contained in:
Nico Kokonas 2023-03-19 04:51:05 -06:00 committed by GitHub
parent efd2230eba
commit 529793fbcb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 47 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/docs/commands/commands.md
View file

@ -2,4 +2,4 @@
title: Commands title: Commands
--- ---
- [`atuin import`](/docs/commands/import) - [`atuin import`](../../docs/commands/import)

2
docs/docs/commands/stats.md
View file

@ -8,7 +8,7 @@ little basic, but more features to come.
You provide the starting point, and Atuin computes the stats for 24h from that point. You provide the starting point, and Atuin computes the stats for 24h from that point.
Date parsing is provided by `interim`, which supports different formats Date parsing is provided by `interim`, which supports different formats
for full or relative dates. Certain formats rely on the dialect option in your for full or relative dates. Certain formats rely on the dialect option in your
[configuration](/docs/config/config.md#dialect) to differentiate day from month. [configuration](../../docs/config/config.md#dialect) to differentiate day from month.
Refer to [the module's documentation](https://docs.rs/interim/0.1.0/interim/#supported-formats) for more details on the supported date formats. Refer to [the module's documentation](https://docs.rs/interim/0.1.0/interim/#supported-formats) for more details on the supported date formats.
``` ```

4
docs/docs/config/config.md
View file

@ -19,11 +19,11 @@ export ATUIN_CONFIG_DIR = /home/ellie/.atuin
The client runs on a user's machine, and unless you're running a server, this The client runs on a user's machine, and unless you're running a server, this
is what you care about. is what you care about.
See [config.toml](../atuin-client/config.toml) for an example See [config.toml](../../../atuin-client/config.toml) for an example
### `dialect` ### `dialect`
This configures how the [stats](/docs/commands/stats.md) command parses dates. It has two This configures how the [stats](../commands/stats.md) command parses dates. It has two
possible values possible values
``` ```

58
docs/docs/index.md
View file

@ -6,7 +6,7 @@ sidebar_position: 1
Atuin replaces your existing shell history with a SQLite database, and records Atuin replaces your existing shell history with a SQLite database, and records
additional context for your commands. Additionally, it provides optional and additional context for your commands. Additionally, it provides optional and
_fully encrypted_ synchronisation of your history between machines, via an Atuin _fully encrypted_ synchronisation of your history between machines, via an Atuin
server. server.
You may use either the server I host, or host your own! Or just don't use sync You may use either the server I host, or host your own! Or just don't use sync
at all. As all history sync is encrypted, I couldn't access your data even if at all. As all history sync is encrypted, I couldn't access your data even if
@ -17,15 +17,15 @@ I wanted to. And I **really** don't want to.
- zsh - zsh
- bash - bash
- fish - fish
## Community ## Community
Atuin has a community Discord, available [here](https://discord.gg/Fq8bJSKPHh)! Please do come and say hi 😊 Atuin has a community Discord, available [here](https://discord.gg/Fq8bJSKPHh)! Please do come and say hi 😊
# Quickstart # Quickstart
This will sign you up for the default sync server, hosted by me. Everything is end-to-end encrypted, so your secrets are safe! This will sign you up for the default sync server, hosted by me. Everything is end-to-end encrypted, so your secrets are safe!
Read more below for offline-only usage, or for hosting your own server. Read more below for offline-only usage, or for hosting your own server.
``` ```
@ -37,27 +37,27 @@ atuin sync
``` ```
Then restart your shell! Then restart your shell!
### Opt-in to activity graph ### Opt-in to activity graph
Alongside the hosted Atuin server, there is also a service which generates activity graphs for your shell history! These are inspired by the GitHub graph. Alongside the hosted Atuin server, there is also a service which generates activity graphs for your shell history! These are inspired by the GitHub graph.
For example, here is mine: For example, here is mine:
![Activity Graph Example](/img/activity-graph-example.png) ![Activity Graph Example](/img/activity-graph-example.png)
If you wish to get your own, after signing up for the sync server, run this If you wish to get your own, after signing up for the sync server, run this
``` ```
curl https://api.atuin.sh/enable -d $(cat ~/.local/share/atuin/session) curl https://api.atuin.sh/enable -d $(cat ~/.local/share/atuin/session)
``` ```
The response includes the URL to your graph. Feel free to share and/or embed this URL, the token is _not_ a secret, and simply prevents user enumeration. The response includes the URL to your graph. Feel free to share and/or embed this URL, the token is _not_ a secret, and simply prevents user enumeration.
## Offline only (no sync) ## Offline only (no sync)
``` ```
bash <(curl https://raw.githubusercontent.com/ellie/atuin/main/install.sh) bash <(curl https://raw.githubusercontent.com/ellie/atuin/main/install.sh)
atuin import auto atuin import auto
``` ```
@ -86,7 +86,7 @@ toolchain, then you can run:
``` ```
cargo install atuin cargo install atuin
``` ```
And then follow [the shell setup](#shell-plugin) And then follow [the shell setup](#shell-plugin)
### Homebrew ### Homebrew
@ -94,17 +94,17 @@ And then follow [the shell setup](#shell-plugin)
``` ```
brew install atuin brew install atuin
``` ```
And then follow [the shell setup](#shell-plugin) And then follow [the shell setup](#shell-plugin)
### MacPorts ### MacPorts
Atuin is also available in [MacPorts](https://ports.macports.org/port/atuin/) Atuin is also available in [MacPorts](https://ports.macports.org/port/atuin/)
``` ```
sudo port install atuin sudo port install atuin
``` ```
And then follow [the shell setup](#shell-plugin) And then follow [the shell setup](#shell-plugin)
### Nix ### Nix
@ -129,7 +129,7 @@ Atuin is available in the Arch Linux [community repository](https://archlinux.or
``` ```
pacman -S atuin pacman -S atuin
``` ```
And then follow [the shell setup](#shell-plugin) And then follow [the shell setup](#shell-plugin)
### Termux ### Termux
@ -139,7 +139,7 @@ Atuin is available in the Termux package repository:
``` ```
pkg install atuin pkg install atuin
``` ```
And then follow [the shell setup](#shell-plugin) And then follow [the shell setup](#shell-plugin)
### From source ### From source
@ -149,7 +149,7 @@ git clone https://github.com/ellie/atuin.git
cd atuin cd atuin
cargo install --path . cargo install --path .
``` ```
And then follow [the shell setup](#shell-plugin) And then follow [the shell setup](#shell-plugin)
## Shell plugin ## Shell plugin
@ -169,9 +169,9 @@ echo 'eval "$(atuin init zsh)"' >> ~/.zshrc
zinit load ellie/atuin zinit load ellie/atuin
``` ```
#### Antigen #### Antigen
```sh ```sh
antigen bundle ellie/atuin@main antigen bundle ellie/atuin@main
``` ```
@ -199,10 +199,10 @@ atuin init fish | source
``` ```
to your `is-interactive` block in your `~/.config/fish/config.fish` file to your `is-interactive` block in your `~/.config/fish/config.fish` file
### Fig ### Fig
Install `atuin` shell plugin in zsh, bash, or fish with [Fig](https://fig.io) in one click. Install `atuin` shell plugin in zsh, bash, or fish with [Fig](https://fig.io) in one click.
<a href="https://fig.io/plugins/other/atuin" target="_blank"><img src="https://fig.io/badges/install-with-fig.svg" /></a> <a href="https://fig.io/plugins/other/atuin" target="_blank"><img src="https://fig.io/badges/install-with-fig.svg" /></a>
@ -211,5 +211,5 @@ Install `atuin` shell plugin in zsh, bash, or fish with [Fig](https://fig.io) in
Atuin is named after "The Great A'Tuin", a giant turtle from Terry Pratchett's Atuin is named after "The Great A'Tuin", a giant turtle from Terry Pratchett's
Discworld series of books. Discworld series of books.
[English]: ./README.md [English]: ../README.md
[简体中文]: ./docs/zh-CN/README.md [简体中文]: ../../docs/zh-CN/README.md

8
docs/docs/self-hosting/k8s.md
View file

@ -2,7 +2,7 @@
You could host your own Atuin server using the Kubernetes platform. You could host your own Atuin server using the Kubernetes platform.
Create a [`secrets.yaml`](../k8s/secrets.yaml) file for the database credentials: Create a [`secrets.yaml`](../../../k8s/secrets.yaml) file for the database credentials:
```yaml ```yaml
apiVersion: v1 apiVersion: v1
@ -20,7 +20,7 @@ stringData:
immutable: true immutable: true
``` ```
Create a [`atuin.yaml`](../k8s/atuin.yaml) file for the Atuin server: Create a [`atuin.yaml`](../../../k8s/atuin.yaml) file for the Atuin server:
```yaml ```yaml
--- ---
@ -165,7 +165,7 @@ spec:
storage: 10Mi storage: 10Mi
``` ```
Finally, you may want to use a separate namespace for atuin, by creating a [`namespace.yaml`](../k8s/namespaces.yaml) file: Finally, you may want to use a separate namespace for atuin, by creating a [`namespaces.yaml`](../../../k8s/namespaces.yaml) file:
```yaml ```yaml
apiVersion: v1 apiVersion: v1
@ -191,4 +191,4 @@ Deploy the Atuin server using `kubectl`:
-f ./atuin.yaml -f ./atuin.yaml
``` ```
The sample files above are also in the [k8s](../k8s) folder of the atuin repository. The sample files above are also in the [k8s](../../../k8s/) folder of the atuin repository.

8
docs/ru/config_ru.md
View file

@ -3,7 +3,7 @@
Autin использует два файла конфигурации. Они хранятся в `~/.config/atuin/`. Данные Autin использует два файла конфигурации. Они хранятся в `~/.config/atuin/`. Данные
хранятся в `~/.local/share/atuin` (если не определено другое в XDG\_\*). хранятся в `~/.local/share/atuin` (если не определено другое в XDG\_\*).
Путь до катклога конфигурации может быть изменён установкой Путь до катклога конфигурации может быть изменён установкой
параметра `ATUIN_CONFIG_DIR`. Например параметра `ATUIN_CONFIG_DIR`. Например
``` ```
@ -18,7 +18,7 @@ export ATUIN_CONFIG_DIR = /home/ellie/.atuin
Этот файл используется когда клиент работает на локальной машине (не сервере). Этот файл используется когда клиент работает на локальной машине (не сервере).
See [config.toml](../atuin-client/config.toml) for an example See [config.toml](../../atuin-client/config.toml) for an example
### `dialect` ### `dialect`
@ -54,7 +54,7 @@ sync_address = "https://api.atuin.sh"
### `sync_frequency` ### `sync_frequency`
Как часто клиент синхронизируется с сервером. Может быть указано в Как часто клиент синхронизируется с сервером. Может быть указано в
понятном для человека формате. Например, `10s`, `20m`, `1h`, и т.д. понятном для человека формате. Например, `10s`, `20m`, `1h`, и т.д.
По умолчанию `1h` По умолчанию `1h`
@ -96,7 +96,7 @@ key = "~/.atuin-session"
Определяет, какой режим поиска будет использоваться. Autin поддерживает "prefix", Определяет, какой режим поиска будет использоваться. Autin поддерживает "prefix",
текст целиком (fulltext) и неточный ("fuzzy") поиск. Режим "prefix" производит текст целиком (fulltext) и неточный ("fuzzy") поиск. Режим "prefix" производит
поиск по "запрос\*", "fulltext" по "\*запрос\*", и "fuzzy" использует поиск по "запрос\*", "fulltext" по "\*запрос\*", и "fuzzy" использует
[вот такой](#fuzzy-search-syntax) синтаксис. [вот такой](#fuzzy-search-syntax) синтаксис.
По умолчанию стоит значение "fuzzy" По умолчанию стоит значение "fuzzy"

12
docs/ru/sync_ru.md
View file

@ -1,12 +1,12 @@
# `atuin sync` # `atuin sync`
Autin может сделать резервную копию вашей истории на сервер чтобы обеспечить использование Autin может сделать резервную копию вашей истории на сервер чтобы обеспечить использование
разными компьютерами одной и той же истории. Вся история будет зашифрована двусторонним шифрованием, разными компьютерами одной и той же истории. Вся история будет зашифрована двусторонним шифрованием,
так что сервер _никогда_ не получит ваши данные! так что сервер _никогда_ не получит ваши данные!
Можно сделать свой сервер (запустив `atuin server start`, об этом написано в других Можно сделать свой сервер (запустив `atuin server start`, об этом написано в других
файлах документациии), но у меня есть свой https://api.atuin.sh. Это серверный адрес по умолчанию, файлах документациии), но у меня есть свой https://api.atuin.sh. Это серверный адрес по умолчанию,
который может быть изменён в [конфигурации](config_ru.md). Опять же, я _не_ могу получить ваши данные который может быть изменён в [конфигурации](config_ru.md). Опять же, я _не_ могу получить ваши данные
и они мне не нужны. и они мне не нужны.
## Частота синхронизации ## Частота синхронизации
@ -26,15 +26,15 @@ Autin может сделать резервную копию вашей ист
atuin register -u <USERNAME> -e <EMAIL> -p <PASSWORD> atuin register -u <USERNAME> -e <EMAIL> -p <PASSWORD>
``` ```
Имена пользователей должны быть уникальны, и электронная почта должна использваться Имена пользователей должны быть уникальны, и электронная почта должна использваться
только для срочных уведомлений (изменения политик, нарушения безопасности и т.д.) только для срочных уведомлений (изменения политик, нарушения безопасности и т.д.)
Псоле регистрации, вы уже сразу вошли в свой аккаунт :) С этого момента синхронизация Псоле регистрации, вы уже сразу вошли в свой аккаунт :) С этого момента синхронизация
будет проходить автоматически будет проходить автоматически
## Ключ ## Ключ
Поскольку все данные шифруются, Autin при работе сгенерирует ваш ключ. Он будет сохранён в Поскольку все данные шифруются, Autin при работе сгенерирует ваш ключ. Он будет сохранён в
каталоге с данными Autin (`~/.local/share/atuin` на системах с GNU/Linux) каталоге с данными Autin (`~/.local/share/atuin` на системах с GNU/Linux)
Также можно сделать это самим: Также можно сделать это самим: