diff --git a/README.md b/README.md index 9633637e30d..7fd1d0d1e95 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@

-[English] | [简体中文] +[English] | [简体中文] | [日本語] Atuin replaces your existing shell history with a SQLite database, and records @@ -132,3 +132,4 @@ Made with [contrib.rocks](https://contrib.rocks). [English]: ./README.md [简体中文]: ./docs/zh-CN/README.md +[日本語]: ./docs/ja/README.md diff --git a/crates/atuin/README.md b/crates/atuin/README.md deleted file mode 120000 index fe840054137..00000000000 --- a/crates/atuin/README.md +++ /dev/null @@ -1 +0,0 @@ -../../README.md \ No newline at end of file diff --git a/crates/atuin/README.md b/crates/atuin/README.md new file mode 100644 index 00000000000..7fd1d0d1e95 --- /dev/null +++ b/crates/atuin/README.md @@ -0,0 +1,135 @@ +

+ + + Text changing depending on mode. Light: 'So light!' Dark: 'So dark!' + +

+ +

+magical shell history +

+ +
+ +

+ + + + + + + + Arm CI sponsored by Actuated +

+ + +[English] | [简体中文] | [日本語] + + +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. + + + + +

+ animated +

+ +

+exit code, duration, time and command shown +

+ + + + + +As well as the search UI, it can do things like this: + +``` +# search for all successful `make` commands, recorded after 3pm yesterday +atuin search --exit 0 --after "yesterday 3pm" make +``` + +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 +I wanted to. And I **really** don't want to. + +## Features + +- rebind `ctrl-r` and `up` (configurable) to a full screen history search UI +- store shell history in a sqlite database +- back up and sync **encrypted** shell history +- the same history across terminals, across sessions, and across machines +- log exit code, cwd, hostname, session, command duration, etc +- calculate statistics such as "most used command" +- old history file is not replaced +- quick-jump to previous items with Alt-\ +- switch filter modes via ctrl-r; search history just from the current session, directory, or globally +- enter to execute a command, tab to edit + +## Documentation + +- [Quickstart](#quickstart) +- [Install](https://docs.atuin.sh/guide/installation/) +- [Setting up sync](https://docs.atuin.sh/guide/sync/) +- [Import history](https://docs.atuin.sh/guide/import/) +- [Basic usage](https://docs.atuin.sh/guide/basic-usage/) +## Supported Shells + +- zsh +- bash +- fish +- nushell +- xonsh + +## Community + +### Forum + +Atuin has a community forum, please ask here for help and support: https://forum.atuin.sh/ + +### Discord + +Atuin also has a community Discord, available [here](https://discord.gg/jR3tfchVvW) + +# Quickstart + +This will sign you up for the Atuin Cloud sync server. Everything is end-to-end encrypted, so your secrets are safe! + +Read more in the [docs](https://docs.atuin.sh) for an offline setup, self hosted server, and more. + +``` +curl --proto '=https' --tlsv1.2 -LsSf https://setup.atuin.sh | sh + +atuin register -u -e +atuin import auto +atuin sync +``` + +Then restart your shell! + +> [!NOTE] +> +> **For Bash users**: The above sets up `bash-preexec` for necessary hooks, but +> `bash-preexec` has limitations. For details, please see the +> [Bash](https://docs.atuin.sh/guide/installation/#installing-the-shell-plugin) +> section of the shell plugin documentation. + +# Security + +If you find any security issues, we'd appreciate it if you could alert ellie@atuin.sh + +# Contributors + + + + + +Made with [contrib.rocks](https://contrib.rocks). + +[English]: ./README.md +[简体中文]: ./docs/zh-CN/README.md +[日本語]: ./docs/ja/README.md diff --git a/docs/ja/README.md b/docs/ja/README.md new file mode 100644 index 00000000000..498ddab7727 --- /dev/null +++ b/docs/ja/README.md @@ -0,0 +1,130 @@ +

+ + + Text changing depending on mode. Light: 'So light!' Dark: 'So dark!' + +

+ +

+魔法のシェル履歴 +

+ +
+ +

+ + + + + + + + Arm CI sponsored by Actuated +

+ + +[English] | [简体中文] | [日本語] + + +Atuinは、既存のシェル履歴をSQLiteデータベースに置き換え、コマンドの追加コンテキストを記録します。さらに、Atuinサーバーを介して、マシン間で履歴を完全に暗号化して同期するオプションも提供します。 + + + + +

+ animated +

+ +

+終了コード、実行時間、時刻、コマンドが表示されます +

+ + + + + +検索UIに加えて、次のようなこともできます： + +``` +# 昨日の午後3時以降に記録された、すべての成功した `make` コマンドを検索 +atuin search --exit 0 --after "yesterday 3pm" make +``` + +私がホストするサーバーを使用するか、自分でホストすることができます！または、同期をまったく使用しないこともできます。すべての履歴同期は暗号化されているため、私がアクセスすることはできませんし、アクセスしたいとも思いません。 + +## 特徴 + +- `ctrl-r` と `up` を全画面履歴検索UIに再バインド（設定可能） +- シェル履歴をsqliteデータベースに保存 +- **暗号化された**シェル履歴のバックアップと同期 +- ターミナル、セッション、マシン間で同じ履歴 +- 終了コード、cwd、ホスト名、セッション、コマンドの実行時間などを記録 +- 「最も使用されたコマンド」などの統計を計算 +- 古い履歴ファイルは置き換えられません +- Alt-\ で以前の項目にクイックジャンプ +- ctrl-rでフィルターモードを切り替え; 現在のセッション、ディレクトリ、またはグローバルから履歴を検索 +- コマンドを実行するにはEnter、編集するにはTabを押します + +## ドキュメント + +- [クイックスタート](#quickstart) +- [インストール](https://docs.atuin.sh/guide/installation/) +- [同期の設定](https://docs.atuin.sh/guide/sync/) +- [履歴のインポート](https://docs.atuin.sh/guide/import/) +- [基本的な使い方](https://docs.atuin.sh/guide/basic-usage/) +## 対応シェル + +- zsh +- bash +- fish +- nushell +- xonsh + +## コミュニティ + +### フォーラム + +Atuinにはコミュニティフォーラムがあります。サポートやヘルプはこちらで質問してください: https://forum.atuin.sh/ + +### Discord + +AtuinにはコミュニティDiscordもあります。こちらから参加できます: [here](https://discord.gg/jR3tfchVvW) + +# クイックスタート + +これにより、Atuin Cloud同期サーバーにサインアップします。すべてがエンドツーエンドで暗号化されているため、秘密は安全です！ + +オフラインセットアップ、自分でホストするサーバーなどの詳細については、[ドキュメント](https://docs.atuin.sh)を参照してください。 + +``` +curl --proto '=https' --tlsv1.2 -LsSf https://setup.atuin.sh | sh + +atuin register -u -e +atuin import auto +atuin sync +``` + +その後、シェルを再起動してください！ + +> [!NOTE] +> +> **Bashユーザー向け**: 上記の手順は必要なフックのために `bash-preexec` を設定しますが、 +> `bash-preexec` には制限があります。詳細については、 +> [Bash](https://docs.atuin.sh/guide/installation/#installing-the-shell-plugin) +> シェルプラグインのドキュメントのセクションを参照してください。 + +# セキュリティ + +セキュリティ上の問題を発見した場合は、ellie@atuin.sh に通知していただけるとありがたいです。 + +# 貢献者 + + + + + +[contrib.rocks](https://contrib.rocks)で作成されました。 + +[English]: ../../README.md +[简体中文]: ../zh-CN/README.md +[日本語]: ./README.md