Commit Graph

102 Commits

Author SHA1 Message Date
cyqsimon
6671f72d1b
Updated client config docs (#839)
* Updated client config docs

- Example `config.toml` now includes all the newest options
- `settings.rs`, `config.toml`, and `config.md` now have uniform option order

* Remove trailing space
2023-04-05 09:32:26 +01:00
Ellie Huxtable
f2a496848a Clarify in docs 2023-04-01 18:45:19 +01:00
Ellie Huxtable
4e4fdb9f8e
Release Atuin v14 (#836)
* Bump versions

* Write release notes

* add link
2023-04-01 18:17:38 +01:00
Tom Cammann
ca5e58ad01
Update atuin search docs (#828)
Add docs for using `--limit` and `--offset` in `atuin search`
2023-03-29 20:41:28 +01:00
Nico Kokonas
529793fbcb
fix: many wins were broken 📝 (#789) 2023-03-19 10:51:05 +00:00
onkelT2
afd1113b3b
Minor documentation updates (#767) 2023-03-08 20:20:39 +00:00
Ellie Huxtable
d46e3ad47d Add hachyderm to home 2023-02-28 22:37:42 +00:00
Ellie Huxtable
b40383fc90
Add Hachyderm links (#742) 2023-02-28 22:27:06 +00:00
Ellie Huxtable
e4fde80acc
Patch release v13.0.1 (#741)
* Patch release v13.0.1

* Update blog post
2023-02-28 21:44:39 +00:00
Maurice Escher
f3bc646f24
[docs] fix some links between config and commands (#733) 2023-02-27 08:12:00 +00:00
Alpha Chen
df9b3b0541
Fix link to self-hosting (#731) 2023-02-27 07:12:26 +00:00
Alpha Chen
ff4606b63a
Fix editURL for docs (#732) 2023-02-27 07:10:52 +00:00
Ellie Huxtable
fe5f728aa6
Release v13 (#727)
* Write release blog post

* Bump versions

* Update contributors
2023-02-26 21:22:29 +00:00
Ellie Huxtable
8a2fa44b01 Docs index page 2023-02-26 00:15:14 +00:00
Ellie Huxtable
e660a4d4fe More fixes :) 2023-02-25 23:55:39 +00:00
Ellie Huxtable
89d3e02931 I think the link checker gets it wrong sometimes 2023-02-25 23:36:06 +00:00
Ellie Huxtable
7ed0df49d6 Fix website build 2023-02-25 23:34:14 +00:00
Ellie Huxtable
c558da5beb
Add fancy web docs (#725)
* Add initial site

* WIP again

* Replace docs with web docs

* Bring back translations

* Update README.md

* remove images
2023-02-25 23:29:59 +00:00
Eric Ripa
78b54662cd
docs(README): add static activity graph example (#680)
resolves ellie/atuin#678
2023-02-10 19:33:52 +00:00
Evan Purkhiser
5d6aff3536
Fix missing - in key-binding.md (#698) 2023-02-07 09:11:55 +00:00
Yolo
028f404b56
docs: Fix typo in zh-CN/README.md (#666) 2023-01-15 15:39:40 +00:00
Baptiste
62f001898a
docs: Remove human short flag from docs, duplicate of help -h (#663) 2023-01-11 21:36:51 +00:00
Jamie Quigley
a5616aea8f
Rework atuin init (#652)
* Rework `atuin init`

This allows users to disable the CTRL-R and Up Arrow bindings,
independently from one another

* Document --disable-{ctrl-r,up-arrow}

* Apply suggestions from code review

Co-authored-by: Ellie Huxtable <ellie@elliehuxtable.com>

Co-authored-by: Ellie Huxtable <ellie@elliehuxtable.com>
2022-12-24 17:18:44 +00:00
Patrick Decat
ed394afa82
Allow overriding filter and search modes from CLI (#635)
* Allow overriding filter and search modes from CLI arguments

* Use session filter mode for bash up key binding

* We precisely do not want to add quotes here so that all arguments are properly passed

* Add --shell-up-key-binding hidden command argument and filter_mode_shell_up_key_binding configuration option to allow customizing the filter mode used when atuin is invoked from a shell up-key binding

* Correct up binding for zsh

Co-authored-by: Ellie Huxtable <ellie@elliehuxtable.com>
2022-12-18 18:26:09 +00:00
Patrick Jackson
b6e18b031f
Fix minor typo in config.md (#615) 2022-11-17 08:04:34 +00:00
Eric Crosson
28021566e8
Fix copy/paste artifact (#598) 2022-11-06 07:41:35 +00:00
Sam Lanning
4768b16b74
Add setting for keeping typed query when exiting (#451)
* Add option for keeping typed query on escape

fixes #422

* chore: Address duplicate if statement blocks
2022-11-06 07:34:14 +00:00
Plamen Dimitrov
f1f40a0d55
Update server.md (#589)
Update the usage of the short flag -h for --help instead of --host.
2022-11-02 20:40:20 +00:00
Benjamin Vergnaud
8b9aae7076
docs: add more details about date parsing in the stats command (#579)
* docs: add more details about date parsing in the stats command

* chore: Replace chrono-english crate with interim
2022-10-21 20:21:14 +01:00
Ellie Huxtable
f03f6e9ad7
Add automatic update checking (#555)
* Add automatic update checking

* Add setting to opt out of update checks

* Document options

* no

* no

* also no

* Make clippy happy

* Update atuin-client/src/settings.rs

Co-authored-by: Conrad Ludgate <conradludgate@gmail.com>

* fix features

Co-authored-by: Conrad Ludgate <conradludgate@gmail.com>
Co-authored-by: Conrad Ludgate <conrad.ludgate@truelayer.com>
2022-10-14 10:59:21 +01:00
Bruce Huang
02049bf68d
update zh-CN docs (#539)
* update zh-CN docs

* update zh-CN docs

* update zh-CN docs

* update zh-CN docs
2022-10-08 03:36:49 +00:00
xfzv
eadf573670
Add style to config.toml and config.md (#552)
* Add `style` to config.toml

* Add `style` to config.md

* Update atuin-client/config.toml

Co-authored-by: Conrad Ludgate <oon@conradludgate.com>

Co-authored-by: Conrad Ludgate <oon@conradludgate.com>
2022-10-05 12:14:56 +00:00
morguldir
0c5e250800
Add support for prepending a path to all routes for the server (#484)
* Add support for prepending a path to all routes

* Don't nest if there is no path provided

Co-authored-by: Conrad Ludgate <oon@conradludgate.com>

* Change the default for the path variable

* run cargo-fmt

Co-authored-by: Conrad Ludgate <oon@conradludgate.com>
2022-07-26 08:05:34 +01:00
Klas Mellbourn
f946644ceb
Add kubernetes instructions and manifests (#427)
* add kubernetes instructions

* minor wording improvements

* better password instructions

* add information about changed port

* improved grammar

* Separate docker and k8s docs

Add k8s folder for kubernetes configs
2022-06-26 18:40:36 +00:00
Ubiquitous Photon
cd2a3ab7d5
Add fish shell to key binding docs (#418)
Add the missing fish shell part into the documentation for ATUIN_NOBIND.

Binding to up is pretty problematic in fish, as if you want to navigate the pager for auto-suggestions, you tend to get a bit stuck.
2022-05-19 21:04:45 +00:00
ZhiHong Li
b7946cc9cb
Update Chinese version README.md (#403) 2022-05-12 06:26:11 +01:00
ZhiHong Li
e05c19d0ff
Add Chinese documentation translation & Fix spelling mistakes (#373)
* Add Chinese documentation translation

* Fix spelling mistakes
2022-05-01 09:25:12 +01:00
mb6ockatf
6e280e253a
Add Russian documentation translation (#365)
* Translate config.md to russian

* Translate docs/import_ru.md to russian

* Translate docs/key-binding.md to russian

* Translate docs/list_ru.md to russian

* Correct misprint in config_ru.md

* Translate docs/search.md to russian

* Translate docs/server_ru.md to russian

* Translate docs/shell-completions.md to russian

* Translate docs/stats.md to russian

* Translate docs/sync.md to russian

* Add .idea/ to .gitignore

* Translated files are placed in a separate folder

* Correct misprint (~~истоии~~ => истории). Correct links between files

Co-authored-by: BigProject404 <bigproject404@yandex.ru>
2022-04-30 20:51:50 +00:00
mundry
831cc98c24
Fix typos in the docs. (#171)
Co-authored-by: mundry <mundry@users.noreply.github.com>
2022-04-22 21:17:05 +01:00
Ellie Huxtable
508d4f4761
History filter (#329)
* Add history filters, and hotkey toggle

Switch between different search modes to narrow down the history you
want - global search for all history, host for all history from your
current machine, session for the current shell session, and directory
for the current directory

The default can be configured via `filter_mode`

* Update docs

* Add context
2022-04-22 21:05:02 +01:00
lchausmann
a9d1ece0cb
Added docker-compose.yml (#325)
Also added section to how to run your own server.

Co-authored-by: Lars Chr. Duus Hausmann <lars.chr@duus-hausmann.dk>
2022-04-22 08:41:55 +00:00
Patrick
fae118a46b
Improve fuzzy search (#279)
* Add SearchMode fzf.

Add a new search mode "fzf" that tries to mimic the search syntax of
https://github.com/junegunn/fzf#search-syntax
This search mode splits the query into terms where each term is matched
individually. Terms can have operators like prefix, suffix, exact match
only and can be inverted. Additionally, smart-case matching is
performed: if a term contains a non-lowercase letter the match will be
case-sensitive.

* PR feedback.

 - Use SearchMode::Fuzzy instead of SearchMode::Fzf
 - update docs
 - re-order tests so previous fuzzy tests come first, add more tests for each operator

* PR comments: remove named arguments, match expression

* PR comments: macro -> async func
2022-03-18 11:37:27 +00:00
Orhun Parmaksız
0abd063e01
Support generating shell completions (#235)
* Add gen-completions subcommand for generating shell completions

* Update documentation about generating shell completions

* Include the shell completions in release tarball
2021-12-10 23:59:39 +00:00
Conrad Ludgate
e89de3f760
chore: supply pre-build docker image (#199)
* feat: supply pre-built docker image

* chore: add docker run to docs
2021-11-17 11:41:55 +00:00
Conrad Ludgate
46a1dab132
fix: dockerfile with correct glibc (#198)
* fix: dockerfile with correct glibc

* chore: update server docs
2021-11-13 22:45:50 +00:00
Frank Hamand
0b9dc6696b
Add fuzzy text search mode (#142) 2021-06-01 08:38:19 +01:00
Frank Hamand
fd90bd3413
Fix doc links in sync.md (#115) 2021-05-11 14:44:13 +00:00
Ellie Huxtable
d3059af815
Release v0.7.0 (#103)
* Release v0.7.0

- Update all the crate versions
- Update the demo gif
- Write a changelog
- Adjust the title of the search screen (has the old name still)
- Adjust the colours of the quick-jump numbers (sadly invisible on some
  colour schemes as dark grey :/)

* Update README, default config file, docs

* Link usernames

* Trigger release workflow upon release creation, as well as tags
2021-05-10 21:28:07 +01:00
Ellie Huxtable
e43e5ce74a
Add logout, only login if not already logged in (#91)
Also:
- Ensures that a key is generated as soon as a user registers!
- Ensures that "atuin key" will generate a key if needed, and doesn't
  double base64 encode data

And a few other little fixes :)

Resolves #85
Resolves #86
2021-05-09 20:11:17 +01:00
Ellie Huxtable
8bd4d12cfa
Add ATUIN_NOBIND (#62)
* Add ATUIN_NOBIND

* Update docs/key-binding.md

`<kbd>`, what magic

Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>

Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>
2021-05-08 14:17:22 +01:00
Ellie Huxtable
cbb472bba6 Update README and docs 2021-05-07 16:59:12 +01:00
Ellie Huxtable
156893d774
Update docs, unify on SQLx, bugfixes (#40)
* Begin moving to sqlx for local too

* Stupid scanners should just have a nice cup of tea

Random internet shit searching for /.env or whatever

* Remove diesel and rusqlite fully
2021-04-25 17:21:52 +00:00