Commit Graph

291 Commits

Author SHA1 Message Date
Matan Kushner b1de63b7a3
docs: Fix landing page formatting 2019-12-17 16:48:17 -05:00
Matan Kushner e078bf4727
docs: Make website docs consistent with README.md 2019-12-17 16:46:43 -05:00
nesmyslny 40d4daba42 docs: Correct summary of `git_commit` module (#737) 2019-12-16 10:45:48 -05:00
Matan Kushner 7c05412f46
docs(i18n): Update doc translations (#697) 2019-12-14 18:46:45 -05:00
Thomas O'Donnell 780816926f docs: Correct a typo in the FAQs (#732)
Have fixed a minor typo in the FAQs to use the `--help` flag rather than
the `--version` flag.
2019-12-13 15:26:23 -05:00
Morten Scheel e38a257656 feat: add composer.json version to Package module (#716) 2019-12-11 21:05:39 -05:00
BuggStream 93701b26b3 feat: Add support for the ion shell (#704) 2019-12-11 15:31:30 -05:00
AppleTheGolden ea04f9bfc1 fix: Add php to the default prompt order (#708) 2019-12-10 11:52:55 -05:00
Matan Kushner ffef8ff144
docs: Add playsinline to landing page video 2019-12-09 16:13:48 -05:00
AppleTheGolden 3c835ba34b fix: Truncate long paths in conda environment names (#694)
Environment names created via conda create -p [path] tend to be too long for comfort, so this truncates them.
2019-12-09 12:59:02 -05:00
Matan Kushner 60a1319524
docs: Reorder terraform option rows for consistency 2019-12-08 20:43:36 -05:00
wdullaer 44b37a7bac feat: Implement terraform module with workspace and version (#644) 2019-12-08 20:42:51 -05:00
Matan Kushner 5a3c9a756d
docs: Add missing quotes in config docs 2019-12-06 18:41:28 -05:00
Matan Kushner 34edf12970
docs(i18n): Update translations (#683) 2019-12-06 17:07:57 -05:00
Dan Wendorf dee25c7b35 feat: Add prefix config to directory module (#642) 2019-12-06 14:19:11 -05:00
Matan Kushner 9f574eaabd
docs: Improve doc consistency 2019-12-06 12:00:23 -05:00
Qingping Hou c5a206e3cf feat: Add git_commit module (#673) 2019-12-06 11:57:42 -05:00
Matan Kushner 5b440c0bb0
docs: Simplify installation process and docs (#643) 2019-12-05 13:15:21 -05:00
Stephen Ball 46904e5045 feat: Add PHP version module (#244) 2019-12-05 13:04:27 -05:00
Matan Kushner 7c031c1551
chore: Disable prettier for head values in vuepress config 2019-12-04 16:01:31 -05:00
Matan Kushner eff13fed01
chore: Use icon image for og:image tag 2019-12-04 15:59:12 -05:00
Matan Kushner 64820aa91b
chore: Update title OG tag for website 2019-12-04 15:52:06 -05:00
Matan Kushner 80deebb1bb
chore: Undo extended page titles 2019-12-04 15:51:05 -05:00
Matan Kushner f1593eb56b
chore: Update webpage titles 2019-12-04 15:50:20 -05:00
Matan Kushner 609ae4235a
chore: Update SEO meta tags with new copy 2019-12-04 15:48:46 -05:00
Matan Kushner 8364e90ac1
chore: Fix casing in website meta tag 2019-12-04 15:36:30 -05:00
Matan Kushner f09ba3b3de
chore: Update website meta tags for SEO 2019-12-04 15:32:54 -05:00
Luca Greco 337f213753 feat: Add the hg_branch module (#569) 2019-12-02 17:37:18 -05:00
Matan Kushner 33df8ac063
docs: Fix typo in FAQ 2019-12-02 13:35:10 -05:00
Matan Kushner d1988fce8c
docs: Fix heading hierarchy in FAQ 2019-12-02 13:13:11 -05:00
Matan Kushner 48804c048d
docs: Add an FAQ page to website (#583) 2019-12-01 18:47:19 -05:00
Matan Kushner 82cfb6bdb9
docs(i18n): New Crowdin translations (#619) 2019-11-29 14:47:23 -05:00
Harrison 4ba1383373 docs: Update README to create ~/.config (#663) 2019-11-28 14:11:58 -05:00
Jason Etcovitch 57f6ea4fc1 docs: Move styles to index (#657) 2019-11-21 17:45:35 -05:00
Matias Kotlik 135dddbb4f feat: Add separator config to the memory module (#603) 2019-11-13 10:57:46 +09:00
Matan Kushner a24a751a0d
docs: Add sitemap and robots.txt 2019-11-05 22:29:46 +09:00
Matan Kushner d30a2c2705
docs(i18n): Update documentation translations (#575) 2019-11-02 20:12:46 +09:00
Thomas O'Donnell 42f6868e3f feat: Enable the python module in virtual envs (#584)
This will enable the python module when a virtual environment has been
activated, this is detected via the `VIRTUAL_ENV` env var.
2019-11-02 20:10:21 +09:00
Cédric Da Fonseca fa1267f12f feat: Add configuration to set how much AWS profile info is shown (#556) 2019-11-02 20:08:54 +09:00
BSKY c58bbcd386 docs: Update installation instructions for fish-shell (#599) 2019-10-29 12:48:45 +09:00
Zhenhui Xie fed1341e22 feat: Add an option to limit the duration of starship directory scanning (#589) 2019-10-28 22:41:16 +09:00
Brian Low 2710d02709 feat: Show git_status counts (#434)
The git_status module can show the count of files next to their respective symbols.
2019-10-26 15:20:20 +09:00
Jürgen Gmach 59148ac4ad docs: Update required Rust version to v1.38 (#592) 2019-10-26 12:20:18 +09:00
Matan Kushner 9f22bce944
docs: Update use_12hr config option name 2019-10-25 10:05:21 +09:00
Yoshi edf5176c37 docs: Fix `Memory Usage` option key (#586) 2019-10-25 09:58:10 +09:00
Matan Kushner e34b3622f3
docs(i18n) Add links Traditional Chinese docs (#574) 2019-10-22 00:10:47 +09:00
Matan Kushner bd79672f48
docs(i18n): Update Crowdin translations (#517)
- Finish translations for Traditional Chinese
2019-10-21 23:42:08 +09:00
Matias Kotlik 86bb923303 refactor: Refactor memory_usage module to use module config. (#515)
Also addresses a number of bugs:
- the percent sign not displaying correctly on some terminal emulators, including kitty
- changing the symbol in the configuration file didn't do anything
- swap being shown even if the system didn't have any
2019-10-21 00:26:04 +09:00
David Knaack 6ab70796db feat: Implement PowerShell support (#470) 2019-10-16 00:10:16 +09:00
Matias Kotlik d2eef11148 refactor: Refactor git_branch module to use new module config (#535) 2019-10-15 20:48:53 +09:00
Zhenhui Xie be2d5cf1cd refactor: Rewrite cmd_duration, directory and env_var module to use module config (#460)
This PR is a batched rewrite of the following modules:
- cmd_duration
- directory
- env_var
2019-10-15 20:34:48 +09:00
Zach Mertes 5303fd7684 feat: Add configuration for hostname truncation (#485) 2019-10-15 01:22:25 +09:00
Thomas Lee b3275d8ddf feat: Show AWS region in `aws` module (#482) 2019-10-15 00:05:03 +09:00
Thomas O'Donnell a18408e30c fix: Fix the spacing around the AWS default symbol (#529)
This updates the default AWS default symbol to include a space after the
symbol to make it a little bit more readable. Have also updated the
README to include the AWS module.
2019-10-14 22:56:16 +09:00
Matan Kushner cb4a92f441
docs(i18n): Update doc translations (#479) 2019-10-11 17:31:19 +09:00
Zhenhui Xie 57b38f17bb refactor: Rewrite hostname, jobs and line_break module to use mo… (#462) 2019-10-10 17:21:52 +09:00
Matan Kushner f51f3edf76
docs: Fix lingering merge conflict in config docs 2019-10-10 13:45:59 +09:00
Keith Wade 9d48706360 feat: Implement timezone offset config option for the time module (#463)
This allows users to configure the time module to display time with a timezone offset other than just their local timezone.
2019-10-10 13:42:57 +09:00
Maarten Mulders 8058b51273 feat: Show Java module when build.sbt is present (#505)
* feat: Show Java icon and info when build.sbt detected

* docs: Mention build.sbt detection
2019-10-07 19:18:01 +09:00
AppleTheGolden 7657af0680 feat: Add conda module (#469) 2019-10-05 13:25:25 -05:00
Thomas Lee 27e8c8f3eb refactor: Rewrite `time` module to use module config (#483)
- Config option renamed: `12hr` → `use_12hr`
2019-10-06 00:07:00 +09:00
Thomas O'Donnell 5a8777ff45 fix: Disable Kubernetes module by default (#488)
Given the global nature of the Kubernetes module, the module has been disabled by default. The opportunity has also been taken to refactor the Kubernetes module to use the new config module.
2019-10-05 18:31:23 +09:00
Matan Kushner abcea4b3d9
docs(i18n): Update Crowdin translations (#441) 2019-10-04 17:57:43 +09:00
Nick Young 6621e4c859 feat: Add dotnet module (#416)
Adds a .NET module, which preferentially parses local/git files to get
the .NET version.
2019-10-02 01:56:48 -05:00
Thomas O'Donnell 9fc5a43355 feat: Add Kubernetes Module (#404)
Adds a Kubernetes module, which works by parsing kubeconfig.
2019-10-01 13:58:24 -05:00
Matan Kushner b744d7afb2
docs: Reword command duration option 2019-10-01 00:01:45 +09:00
Matan Kushner 9e9eb6a8ef
fix: Disable memory_usage by default (#451) 2019-09-30 16:04:49 +09:00
Tom Hotston 7588137b09 feat: Added ability for setting command duration prefix (#414) 2019-09-30 14:26:32 +09:00
Andrew Houts 0eafb2bde7 feat: add memory usage module (#403)
Adds a module to display system memory and swap usage.
2019-09-29 00:55:48 -05:00
Matan Kushner 85956c7f94
docs(i18n): Finish translating documentation in Japanese (#433)
This last wave of translations has been completed on Crowdin.
2019-09-28 20:31:56 +09:00
Matan Kushner c49e54b16b
docs: Add extra newlines around custom containers 2019-09-28 20:20:18 +09:00
Matan Kushner b29891adf9
docs: Small fixes to the config docs 2019-09-28 01:17:53 +09:00
yuri d3fc66c0c5 feat: Add Environment Variable module (#409) 2019-09-26 17:30:58 +09:00
Thomas O'Donnell b050c59708 feat: Add AWS module (#419)
Adds a module for displaying the current AWS profile based 
on the AWS_PROFILE envar.
2019-09-25 21:55:47 -05:00
Matan Kushner caaf3bc6a9
revert: Revert the command duration in ms feature (#380) (#425)
Due to incompatibilities with the macOS date utility, we are
temporarily reverting this feature.

Refs: #c5e971a
2019-09-25 17:13:58 +09:00
Tom Hotston c5e971aef8 feat: Add ability for command duration in milliseconds (#380) 2019-09-24 14:03:10 -05:00
Gimbar 702ad274cf feat: Add option to always show the username module (#408) 2019-09-22 15:32:11 -05:00
谢祯晖 14fe246138 fix: Add display for unknown battery state (#316) 2019-09-20 12:52:54 -04:00
Kevin Song c2875d99b6 feat: add support for logical paths in directory (#366)
Adds the ability for starship to display the logical path instead of the physical path.
2019-09-20 12:28:09 -04:00
Kuba Clark 71f03ec3e9 feat: Add Java Module (#314)
Implements a Java module which shows basic Java information when inside a Java project.
2019-09-19 18:02:53 -05:00
Iván 74e6170f9f ​docs: Fix typo (confguring ➜ configuring) (#385) 2019-09-17 12:41:35 -04:00
Shu Kutsuzawa f794574be8 docs(i18n): Translate #367 to Japanese (#379)
Signed-off-by: cappyzawa <cappyzawa@yahoo.ne.jp>
Co-authored-by: Kutsuzawa Ryo <kutsuzawa2851@gmail.com>
2019-09-16 12:19:47 -04:00
Kutsuzawa Ryo 7a98ec1d8e feat: Add configuration for the `git_status` prefix and suffix (#367) 2019-09-15 16:44:53 -04:00
Nikodem Rabuliński 8014e9276e docs: Fix default order in docs (#376) 2019-09-15 14:57:30 -04:00
Shu Kutsuzawa af6ba3e502 docs(i18n): Translate #369 to Japanese (#374) 2019-09-15 14:55:02 -04:00
Thomas O'Donnell 653def05f0 Enable the python module for tox files (#369)
Enable the python module if the current directory contains a `tox.ini`
file.
2019-09-15 12:21:40 -04:00
Shu Kutsuzawa 19bb2a4a0a docs(i18n): Translate advanced config to Japanese (#371) 2019-09-15 10:39:26 -04:00
Matan Kushner 8f03c14582
docs: Reword the default prompt_order docs 2019-09-13 10:24:07 -04:00
Shu Kutsuzawa 8a0aa3907c docs(i18n): Fixed translation docs(battery, git_branch, git_stat… (#363) 2019-09-13 10:10:55 -04:00
Shu Kutsuzawa d5f9775660 docs(i18n): Fixed translation docs (#361) 2019-09-12 22:29:42 -04:00
Shu Kutsuzawa cd218a137a docs(i18n): Translated #318 to Japanese (#359)
Signed-off-by: heyrict <xiezh0831@yahoo.co.jp>
2019-09-12 21:38:58 -04:00
Shu Kutsuzawa 0e52b504ea docs(i18n): Translated #358 to Japanese (#360)
Signed-off-by: Kutsuzawa Ryo <kutsuzawa2851@gmail.com>
2019-09-12 21:31:42 -04:00
Rob Warner 373493be85 feat: Add support for italic styles (#354) (#358) 2019-09-12 16:10:42 -05:00
Shu Kutsuzawa 482f005d58 docs(i18n): Localize the configuration documentation in Japanese (#339) 2019-09-12 15:41:23 -04:00
谢祯晖 a6c64e8457 feat: Implement threshold based styling for battery module (#318) 2019-09-12 14:06:59 -04:00
Matan Kushner dc419e8e8a
docs(i18n): Localize the landing page in Japanese (#333)
Co-Authored-By: Yuji Ueki <unhappychoice@gmail.com>
Co-Authored-By: Shu Kutsuzawa <cappyzawa@yahoo.ne.jp>
Co-Authored-By: heyrict <xiezh0831@yahoo.co.jp>
2019-09-11 11:57:24 -04:00
John Letey f9a4514045 feat: Implement the prompt module for time (#138)
Add a module which displays the current time in a format requested by
the user. Disabled by default.
2019-09-10 12:54:40 -05:00
Weihang Lo 59d066c01f docs: reorder misplaced Ruby option example (#317) 2019-09-08 09:57:52 -05:00
Kevin Song 9721666d33
feat: Add the ability to configure per-module color styles (#285)
Add parsing logic, config support, docs, and integration with other modules 
for custom styling of each module.
2019-09-07 19:33:06 -05:00
Nick Young eb724279da feat: Adds Git State module for showing "REBASING 2/3", etc. (#276)
- Adds the git_state module.
- Adds git_state to the default prompt order
- Updates the documentation to describe the git_state module
2019-09-05 12:45:04 -04:00
Neil Kistner 1c66869117 feat: Add config for ahead/behind count of tracked branch (#281)
Add a configuration option (show_sync_count) to the git_status module that will show/hide the counts ahead/behind of the tracked branch. Currently have this default to false, and would opt-in to show this information.
2019-09-05 00:09:51 -04:00
Andrew Houts 84688e4981 feat: add hostname module (#286)
Add a hostname module as requested by @chipbuster.
Displays the system hostname as provided by gethostname.
2019-09-04 13:03:31 -04:00
Titouan Vervack 59e8b1fc92 feat: added truncation_length/symbol to git_branch (#268)
Git branches can become very long (e.g. gitlab auto-generated branch
names), thus it would be nice to be able to truncate them to keep your
prompt lenght in line.

This patch adds two new options to the git_branch module:
* truncation_length: The amount of graphemes to of a gitbranch to
truncate to
* truncation_symbol: The symbol that should be used to indicate that a
branch name was trunctated

To be able to correctly work with UTF-8 graphemes, unicode-segmentation
was added as a dependency.
2019-09-02 15:56:59 -04:00
Thomas O'Donnell de4a715333 docs: "staged" git config option in docs (#271)
Have corrected the documentation for the git module. The docs now use
the correct option `staged` rather than `added`.
2019-09-02 11:44:20 -04:00
Quinn Strahl 3dd035056d Support vicmd_symbol in fish-shell (#254) 2019-08-31 00:59:18 -07:00
Matan Kushner c121dd4d44
docs: Add undocumented config options (#262) 2019-08-29 13:09:36 -04:00
Harry Mills 9918dd1aac docs: Correct a copy/paste error in the docs (#259) 2019-08-29 12:41:09 -04:00
Bruno Bigras ed27cf4a2c docs: add termux install instructions (#248) 2019-08-27 19:32:26 -04:00
Neil Kistner e034253a5e feat: Add ability to use an alternate directory truncation style (#239)
* Add ability to use an alternate directory truncation style
2019-08-26 21:52:45 -04:00
Bruno Bigras feb737190e Add nix-shell support (#173) 2019-08-25 11:41:20 -04:00
Matan Kushner e31b3391f1
docs: Add new demo gif to README (#231)
Since the prompt has been updated to have a new default character symbol, it's time we update the demo gif to reflect those changes.
2019-08-22 20:03:45 -04:00
Thomas O'Donnell 1478f8c2e9 Add support for detecting Python from Pipenv files (#221)
Added the ability to enable the Python module based on the existence of the a `Pipfile`.
2019-08-21 15:54:22 -07:00
Kevin Song 360ea988e5
Add ruby to default module ordering (#217) 2019-08-21 12:41:01 -07:00
Shu Kutsuzawa faa2280620 Correct description of Rust symbol in docs (#219)
Signed-off-by: cappyzawa <cappyzawa@yahoo.ne.jp>
2019-08-21 09:08:56 -07:00
Matan Kushner dcb78a4e0b
docs: Add a GA tag 2019-08-20 11:13:19 -04:00
Bruno Bigras ff8b2a3387 docs: Add Nix installation instructions (#191) 2019-08-20 00:50:35 -04:00
Matan Kushner 2e39c6d0fa
docs: Small README.md fixes 2019-08-19 15:50:36 -04:00
Kevin Song a8a553578b docs: Add AUR install instructions (#187) 2019-08-19 11:10:25 -04:00
Saurav Sharma f54322f2ab feat: Add configuration for reordering the prompt module and disabling default order (#171)
Adds functionality for reordering the prompt module through the use of the prompt_order configuration option in starship.toml
2019-08-18 21:35:11 -07:00
Matan Kushner f7a77edb35
docs: Update setup instructions on landing page (#184) 2019-08-18 13:45:36 -04:00
Kevin Song 85ac0a6801 fix: Set default prompt character to ❯ (#177) 2019-08-18 11:34:45 -04:00
Saghm Rossi dfe2ae643a fix a few typos (#178) 2019-08-17 20:50:42 -07:00
Kevin Song 8782e300fc
feat: Allow bash users to specify a precmd function (#166)
Allows bash users to run a function before the shell is drawn, by defining a function and setting its name equal to starship_precmd_user_func.
2019-08-17 16:53:59 -07:00
Matan Kushner 7475c3dd72
docs: Small doc touch-ups (#176) 2019-08-17 16:38:20 -04:00
Shu Kutsuzawa d90c43b8b1 feat: Display Vi mode as PROMPT (#169)
Add Vi-mode indicator for zsh
2019-08-17 12:33:19 -07:00
Saghm Rossi 84c394e7b0 feat: Add option to control git directory truncation (#165) 2019-08-16 20:29:22 -07:00
Kevin Lane e262187f4c feat: Display Python package version from poetry (#153) 2019-08-15 16:41:06 -04:00
Linus Unnebäck 8671fe89db docs: Fix typo in Ruby module description (#152) 2019-08-14 11:27:38 -04:00
Kevin Song 22c8c3459f feat: implement `cmd_duration` for bash (#144) 2019-08-13 22:49:47 -04:00
André Zanellato b06249d61c feat: implement the ruby module (#131) 2019-08-13 18:43:29 -04:00
MaT1g3R 160a79fa06 feat: Implement configuration to display pyenv version name (#140)
This behavior can be enabled via setting `use_pyenv` to true.
The "pyenv" prefix before the version name can be configured using `pyenv_prefix`.
2019-08-12 21:12:55 -04:00
John Letey 82cf484ced feat: Implement the prompt module for jobs (#85) 2019-08-12 13:42:33 -04:00
MaT1g3R 3669e389b6 feat: Implement Python virtual environment display (#137) 2019-08-11 17:51:13 -04:00
Kevin Song 39598ec691 feat: Add configuration to change the character for non-zero sta… (#133)
Prompt can now switch characters in addition to switching character color. Add configuration options in so that users can do either, both, or neither.
2019-08-10 17:30:30 -04:00
Kevin Song 3daf3ddf26 feat: implement timer module (#118)
Implement a timer module that takes a commandline argument, the number of seconds the last job took to complete, and displays it if appropriate.

Alters shell initialization files to compute this number using date +%s where needed.

Adds a config section to configure minimum amount of time before timer is shown (default is 2s)
2019-08-08 13:25:30 -04:00
Matan Kushner 6cfc6ac5bb
docs: Add detail to the truncation_length description 2019-07-28 23:18:24 -04:00
Matan Kushner 409efd9caa
docs: Fix table formatting for prompt config 2019-07-28 23:15:58 -04:00
Andrew Dassonville 5dbf4381ac feat: Allow directory truncation length to be configured (#120)
This allows the directory truncation length to be configured. Previously, it was hard-coded to truncate to 3 parent directories.
2019-07-28 21:05:13 -04:00
Matan Kushner 0bc28c521d
feat: Add configuration for add_newline (#116)
- Replace TableExt with a Config trait that extends toml::value::Table
Add configuration for add_newline
- add_newline is a root-level configuration value. When set to false, the initial newline before the prompt is removed.
2019-07-27 18:25:13 -04:00
Matan Kushner 95ce43ee70
docs: Attribute copyright to Starship Contributors (#115) 2019-07-25 12:50:29 -04:00
Tiffany Le-Nguyen 08cf33522a docs: Add vuepress with initial docs (#99)
Co-authored-by: Tiffany Le-Nguyen <tlenguyen@expedia.com>
Co-authored-by: Matan Kushner <hello@matchai.me>
2019-07-19 16:18:52 -04:00