mirror of
https://github.com/atuinsh/atuin.git
synced 2024-11-22 08:13:57 +01:00
fix: many wins were broken 📝 (#789)
This commit is contained in:
Nico Kokonas
GitHub
parent
efd2230eba
commit
529793fbcb
@ -2,4 +2,4 @@
|
||||
title: Commands
|
||||
---
|
||||
|
||||
- [`atuin import`](/docs/commands/import)
|
||||
- [`atuin import`](../../docs/commands/import)
|
||||
|
||||
@ -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.
|
||||
Date parsing is provided by `interim`, which supports different formats
|
||||
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.
|
||||
|
||||
```
|
||||
|
||||
@ -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
|
||||
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`
|
||||
|
||||
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
|
||||
|
||||
```
|
||||
|
||||
@ -6,7 +6,7 @@ sidebar_position: 1
|
||||
Atuin replaces your existing shell history with a SQLite database, and records
|
||||
additional context for your commands. Additionally, it provides optional and
|
||||
_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
|
||||
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
|
||||
- bash
|
||||
- fish
|
||||
|
||||
|
||||
## Community
|
||||
|
||||
Atuin has a community Discord, available [here](https://discord.gg/Fq8bJSKPHh)! Please do come and say hi 😊
|
||||
|
||||
# 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!
|
||||
|
||||
|
||||
Read more below for offline-only usage, or for hosting your own server.
|
||||
|
||||
```
|
||||
@ -37,27 +37,27 @@ atuin sync
|
||||
```
|
||||
|
||||
Then restart your shell!
|
||||
|
||||
|
||||
### 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.
|
||||
|
||||
|
||||
For example, here is mine:
|
||||
|
||||
|
||||
|
||||
|
||||
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)
|
||||
```
|
||||
|
||||
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)
|
||||
|
||||
|
||||
```
|
||||
bash <(curl https://raw.githubusercontent.com/ellie/atuin/main/install.sh)
|
||||
|
||||
|
||||
atuin import auto
|
||||
```
|
||||
|
||||
@ -86,7 +86,7 @@ toolchain, then you can run:
|
||||
```
|
||||
cargo install atuin
|
||||
```
|
||||
|
||||
|
||||
And then follow [the shell setup](#shell-plugin)
|
||||
|
||||
### Homebrew
|
||||
@ -94,17 +94,17 @@ And then follow [the shell setup](#shell-plugin)
|
||||
```
|
||||
brew install atuin
|
||||
```
|
||||
|
||||
|
||||
And then follow [the shell setup](#shell-plugin)
|
||||
|
||||
|
||||
### 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
|
||||
```
|
||||
|
||||
|
||||
And then follow [the shell setup](#shell-plugin)
|
||||
|
||||
### Nix
|
||||
@ -129,7 +129,7 @@ Atuin is available in the Arch Linux [community repository](https://archlinux.or
|
||||
```
|
||||
pacman -S atuin
|
||||
```
|
||||
|
||||
|
||||
And then follow [the shell setup](#shell-plugin)
|
||||
|
||||
### Termux
|
||||
@ -139,7 +139,7 @@ Atuin is available in the Termux package repository:
|
||||
```
|
||||
pkg install atuin
|
||||
```
|
||||
|
||||
|
||||
And then follow [the shell setup](#shell-plugin)
|
||||
|
||||
### From source
|
||||
@ -149,7 +149,7 @@ git clone https://github.com/ellie/atuin.git
|
||||
cd atuin
|
||||
cargo install --path .
|
||||
```
|
||||
|
||||
|
||||
And then follow [the shell setup](#shell-plugin)
|
||||
|
||||
## Shell plugin
|
||||
@ -169,9 +169,9 @@ echo 'eval "$(atuin init zsh)"' >> ~/.zshrc
|
||||
zinit load ellie/atuin
|
||||
```
|
||||
|
||||
#### Antigen
|
||||
|
||||
```sh
|
||||
#### Antigen
|
||||
|
||||
```sh
|
||||
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
|
||||
|
||||
|
||||
### 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>
|
||||
|
||||
@ -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
|
||||
Discworld series of books.
|
||||
|
||||
[English]: ./README.md
|
||||
[简体中文]: ./docs/zh-CN/README.md
|
||||
[English]: ../README.md
|
||||
[简体中文]: ../../docs/zh-CN/README.md
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
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
|
||||
apiVersion: v1
|
||||
@ -20,7 +20,7 @@ stringData:
|
||||
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
|
||||
---
|
||||
@ -165,7 +165,7 @@ spec:
|
||||
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
|
||||
apiVersion: v1
|
||||
@ -191,4 +191,4 @@ Deploy the Atuin server using `kubectl`:
|
||||
-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.
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
Autin использует два файла конфигурации. Они хранятся в `~/.config/atuin/`. Данные
|
||||
хранятся в `~/.local/share/atuin` (если не определено другое в XDG\_\*).
|
||||
|
||||
Путь до катклога конфигурации может быть изменён установкой
|
||||
Путь до катклога конфигурации может быть изменён установкой
|
||||
параметра `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`
|
||||
|
||||
@ -54,7 +54,7 @@ sync_address = "https://api.atuin.sh"
|
||||
|
||||
### `sync_frequency`
|
||||
|
||||
Как часто клиент синхронизируется с сервером. Может быть указано в
|
||||
Как часто клиент синхронизируется с сервером. Может быть указано в
|
||||
понятном для человека формате. Например, `10s`, `20m`, `1h`, и т.д.
|
||||
По умолчанию `1h`
|
||||
|
||||
@ -96,7 +96,7 @@ key = "~/.atuin-session"
|
||||
|
||||
Определяет, какой режим поиска будет использоваться. Autin поддерживает "prefix",
|
||||
текст целиком (fulltext) и неточный ("fuzzy") поиск. Режим "prefix" производит
|
||||
поиск по "запрос\*", "fulltext" по "\*запрос\*", и "fuzzy" использует
|
||||
поиск по "запрос\*", "fulltext" по "\*запрос\*", и "fuzzy" использует
|
||||
[вот такой](#fuzzy-search-syntax) синтаксис.
|
||||
|
||||
По умолчанию стоит значение "fuzzy"
|
||||
|
||||
@ -1,12 +1,12 @@
|
||||
# `atuin sync`
|
||||
|
||||
Autin может сделать резервную копию вашей истории на сервер чтобы обеспечить использование
|
||||
Autin может сделать резервную копию вашей истории на сервер чтобы обеспечить использование
|
||||
разными компьютерами одной и той же истории. Вся история будет зашифрована двусторонним шифрованием,
|
||||
так что сервер _никогда_ не получит ваши данные!
|
||||
|
||||
Можно сделать свой сервер (запустив `atuin server start`, об этом написано в других
|
||||
Можно сделать свой сервер (запустив `atuin server start`, об этом написано в других
|
||||
файлах документациии), но у меня есть свой https://api.atuin.sh. Это серверный адрес по умолчанию,
|
||||
который может быть изменён в [конфигурации](config_ru.md). Опять же, я _не_ могу получить ваши данные
|
||||
который может быть изменён в [конфигурации](config_ru.md). Опять же, я _не_ могу получить ваши данные
|
||||
и они мне не нужны.
|
||||
|
||||
## Частота синхронизации
|
||||
@ -26,15 +26,15 @@ Autin может сделать резервную копию вашей ист
|
||||
atuin register -u <USERNAME> -e <EMAIL> -p <PASSWORD>
|
||||
```
|
||||
|
||||
Имена пользователей должны быть уникальны, и электронная почта должна использваться
|
||||
Имена пользователей должны быть уникальны, и электронная почта должна использваться
|
||||
только для срочных уведомлений (изменения политик, нарушения безопасности и т.д.)
|
||||
|
||||
Псоле регистрации, вы уже сразу вошли в свой аккаунт :) С этого момента синхронизация
|
||||
Псоле регистрации, вы уже сразу вошли в свой аккаунт :) С этого момента синхронизация
|
||||
будет проходить автоматически
|
||||
|
||||
## Ключ
|
||||
|
||||
Поскольку все данные шифруются, Autin при работе сгенерирует ваш ключ. Он будет сохранён в
|
||||
Поскольку все данные шифруются, Autin при работе сгенерирует ваш ключ. Он будет сохранён в
|
||||
каталоге с данными Autin (`~/.local/share/atuin` на системах с GNU/Linux)
|
||||
|
||||
Также можно сделать это самим:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user