starship/docs/id-ID/config

Konfigurasi

Untuk memulai mengkonfigurasi starship, buatlah file berikut: ~/.config/starship.toml.

mkdir -p ~/.config && touch ~/.config/starship.toml

Seluruh konfigurasi starship dilakukan dalam file TOML berikut:

# Get editor completions based on the config schema
"$schema" = 'https://starship.rs/config-schema.json'

# Inserts a blank line between shell prompts
add_newline = true

# Replace the '❯' symbol in the prompt with '➜'
[character] # The name of the module we are configuring is 'character'
success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set to '➜' with the color 'bold green'

# Disable the package module, hiding it from the prompt completely
[package]
disabled = true

Config File Location

Kamu bisa mengganti lokasi file konfigurasi bawaan dengan menggunakan environment variable dari STARSHIP_CONFIG:

export STARSHIP_CONFIG=~/example/non/default/path/starship.toml

Pada PowerShell (Windows), tambahkan baris berikut pada $PROFILE:

$ENV:STARSHIP_CONFIG = "$HOME\example\non\default\path\starship.toml"

Or for Cmd (Windows) would be adding this line to your starship.lua:

os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\starship.toml')

Logging

By default starship logs warnings and errors into a file named ~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log, where the session key is corresponding to an instance of your terminal. Namun, hal tersebut dapat diubah dengan menggunakan environment variable dari STARSHIP_CACHE berikut:

export STARSHIP_CONFIG=~/.starship/cache

Ekuivalen dalam PowerShell (Windows), tambahkan baris berikut pada $PROFILE:

$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"

Or for Cmd (Windows) would be adding this line to your starship.lua:

os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')

Terminologi

Modul: Sebuah komponen pada prompt yang memberikan informasi berdasarkan info kontekstual sistem operasimu. Sebagai contoh, modul "nodejs" menampilkan versi Node.js yang tengah terpasang pada komputermu, jika direktorimu sedang berada pada proyek Node.js.

Variabel: Sub-komponen yang terdiri dari informasi yang disediakan oleh modul. Sebagai contoh, variabel "version" dalam modul "nodejs" memuat versi terikini dari Node.js.

Secara konvensi, sebagian modul memiliki prefiks bawaan pada warna terminal (mis. via pada "nodejs") dan juga sebuah ruang kosong sebagai sufiks.

Strings

In TOML syntax, text values are declared with ', ", ''', or """.

The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: $ [ ] ( ).

Symbol	Type	Notes
'	literal string	less escaping
"	string	more escaping
'''	multi-line literal string	less escaping
"""	multi-line string	more escaping, newlines in declarations can be ignored

Sebagai contoh:

# literal string
format = '☺\☻ '

# regular string
format = "☺\\☻ "

# escaping Starship symbols
format = '\[\$\] '

When using line breaks, multi-line declarations can be used. For example, if you want to print a $ symbol on a new line, the following values for format are equivalent:

# with literal string
format = '''

\$'''

# with multiline basic string
format = """

\\$"""

# with basic string
format = "\n\\$"

In multiline basic strings, newlines can be used for formatting without being present in the value by escaping them.

format = """
line1\
line1\
line1
line2\
line2\
line2
"""

Format String

Format string merupakan format yang sebuah modul gunakan untuk menampilkan semua variabelnya. Sebagian besar modul memiliki sebuah entri yang disebut format yang mengkonfigurasi format tampilan pada modul. Kamu bisa menggunakan teks, variabel, dan grup teks di dalam sebuah format string.

Variabel

Variabel memilki simbol $ yang diikuti dengan nama variabelnya. The name of a variable can only contain letters, numbers and _.

Sebagai contoh:

• '$version' is a format string with a variable named version.
• '$git_branch$git_commit' is a format string with two variables named git_branch and git_commit.
• '$git_branch $git_commit' has the two variables separated with a space.

Grup Teks

Grup teks dibuat dengan dua bagian yang berbeda.

Bagian pertama, yang mana diapit dalam sebuah [], merupakan sebuah format string. Kamu bisa menambahkan teks, variabel, atau bahkan grup teks bercabang di dalamnya.

Pada bagian kedua, yang mana diapit dalam sebuah (), merupakan sebuah penataan string. This can be used to style the first part.

Sebagai contoh:

• '[on](red bold)' will print a string on with bold text colored red.
• '[⌘ $version](bold green)' will print a symbol ⌘ followed by the content of variable version, with bold text colored green.
• '[a [b](red) c](green)' will print a b c with b red, and a and c green.

Penataan String

Sebagian besar modul starship memungkinkan kamu untuk mengkonfigurasi gaya tampilannya. Hal ini dilakukan dengan sebuah entri (biasanya style) yang konfigurasinya ditentukan oleh string. Berikut adalah beberapa contoh penataan pada string dan kegunaannya. Untuk detail sintaksis yang lebih lengkap, lihat panduan konfigurasi lanjutan.

• 'fg:green bg:blue' sets green text on a blue background
• 'bg:blue fg:bright-green' sets bright green text on a blue background
• 'bold fg:27' sets bold text with ANSI color 27
• 'underline bg:#bf5700' sets underlined text on a burnt orange background
• 'bold italic fg:purple' sets bold italic purple text
• '' explicitly disables all styling

Perhatikan bagaimana nantinya penataanmu akan terlihat pada emulator terminalmu. Sebagai contoh, beberapa terminal emulator alih-alih membuat warnanya lebih terang, malah menebalkan teksnya, dan sebagian palet warna ada yang menggunakan nilai yang sama untuk warna normal dan terangnya. Dan juga, untuk memakai teks miring, terminalmu harus menunjang teks miring.

Format String Bersyarat (Conditional)

Sebuah string dengan format bersyarat dibungkus dengan ( dan ) tidak akan dijalankan jika variabel di dalamnya kosong.

Sebagai contoh:

• '(@$region)' will show nothing if the variable region is None or empty string, otherwise @ followed by the value of region.
• '(some text)' will always show nothing since there are no variables wrapped in the braces.
• When $combined is a shortcut for \[$a$b\], '($combined)' will show nothing only if $a and $b are both None. This works the same as '(\[$a$b\] )'.

Negative matching

Many modules have detect_extensions, detect_files, and detect_folders variables. These take lists of strings to match or not match. "Negative" options, those which should not be matched, are indicated with a leading '!' character. The presence of any negative indicator in the directory will result in the module not being matched.

Extensions are matched against both the characters after the last dot in a filename, and the characters after the first dot in a filename. For example, foo.bar.tar.gz will be matched against bar.tar.gz and gz in the detect_extensions variable. Files whose name begins with a dot are not considered to have extensions at all.

To see how this works in practice, you could match TypeScript but not MPEG Transport Stream files thus:

detect_extensions = ['ts', '!video.ts', '!audio.ts']

Prompt

Berikut adalah opsi konfigurasi dari list yang bersifat prompt-wide.

Opsi

Opsi	Bawaan	Deskripsi
fromat	link	Mengkonfigurasi format pada prompt.
right_format	''	See Enable Right Prompt
scan_timeout	30	Batas waktu starpship untuk memindai file (dalam milidetik).
command_timeout	500	Batas waktu untuk perintah yang dijalankan starship (dalam milidetik).
add_newline	true	Memasukkan baris kosong antara prompt shell.
palette	''	Sets which color palette from palettes to use.
palettes	{}	Collection of color palettes that assign colors to user-defined names. Note that color palettes cannot reference their own color definitions.

Contoh

# ~/.config/starship.toml

# Use custom format
format = '''
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
[└─>](bold green) '''

# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10

# Disable the blank line at the start of the prompt
add_newline = false

# Set 'foo' as custom color palette
palette = 'foo'

# Define custom colors
[palettes.foo]
# Overwrite existing color
blue = '21'
# Define new color
mustard = '#af8700'

Format Prompt Bawaan

Aturan format bawaan digunakan untuk mendefinisikan format pada prompt, apabila kosong atau tidak ada format yang diberikan. Aturannya seperti yang ditunjukkan:

format = '$all'

# Which is equivalent to
format = """
$username\
$hostname\
$localip\
$shlvl\
$singularity\
$kubernetes\
$directory\
$vcsh\
$fossil_branch\
$fossil_metrics\
$git_branch\
$git_commit\
$git_state\
$git_metrics\
$git_status\
$hg_branch\
$pijul_channel\
$docker_context\
$package\
$c\
$cmake\
$cobol\
$daml\
$dart\
$deno\
$dotnet\
$elixir\
$elm\
$erlang\
$fennel\
$golang\
$guix_shell\
$haskell\
$haxe\
$helm\
$java\
$julia\
$kotlin\
$gradle\
$lua\
$nim\
$nodejs\
$ocaml\
$opa\
$perl\
$php\
$pulumi\
$purescript\
$python\
$raku\
$rlang\
$red\
$ruby\
$rust\
$scala\
$solidity\
$swift\
$terraform\
$vlang\
$vagrant\
$zig\
$buf\
$nix_shell\
$conda\
$meson\
$spack\
$memory_usage\
$aws\
$gcloud\
$openstack\
$azure\
$env_var\
$crystal\
$custom\
$sudo\
$cmd_duration\
$line_break\
$jobs\
$battery\
$time\
$status\
$os\
$container\
$shell\
$character"""

If you just want to extend the default format, you can use $all; modules you explicitly add to the format will not be duplicated. Eg.

# Move the directory to the second line
format = '$all$directory$character'

AWS

The aws module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the AWS_REGION, AWS_DEFAULT_REGION, and AWS_PROFILE env vars and the ~/.aws/config and ~/.aws/credentials files as required.

The module will display a profile only if its credentials are present in ~/.aws/credentials or if a credential_process, sso_start_url, or sso_session are defined in ~/.aws/config. Alternatively, having any of the AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, or AWS_SESSION_TOKEN env vars defined will also suffice. If the option force_display is set to true, all available information will be displayed even if no credentials per the conditions above are detected.

Ketika menggunakan aws-vault, profil dibaca dari variabel environment AWS_VAULT dan tanggal kedaluwarsanya dibaca dari variabel environment AWS_SESSION_EXPIRATION.

Ketika menggunakan awsu profil dibaca dari variabel environment AWSU_PROFILE.

Ketika menggunakan AWSume profil dibaca dari variabel environment AWSUME_PROFILE dan tanggal kedaluwarsanya dibaca dari variabel environment AWSUME_EXPIRATION.

When using saml2aws the expiration information obtained from ~/.aws/credentials falls back to the x_security_token_expires key.

Opsi

Opsi	Bawaan	Deskripsi
format	'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'	Format dari modul.
symbol	'☁️ '	Simbol yang digunakan sebelum menampilkan profil AWS terkini.
region_aliases	{}	Tabel alias dari region yang ditampilan selain nama AWS.
profile_aliases	{}	Table of profile aliases to display in addition to the AWS name.
style	'bold yellow'	Gaya penataan untuk modul.
expiration_symbol	X	Simbol ditampilkan ketika temporer kredensial telah kedaluwarsa.
disabled	false	Menonaktifkan modul AWS.
force_display	false	If true displays info even if credentials, credential_process or sso_start_url have not been setup.

Variabel

Variabel	Contoh	Deskripsi
region	ap-northeast-1	Region AWS terkini
profile	astronauts	Profil AWS terkini
duration	2h27m20s	Durasi temporer kredensial
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

Menampilkan semuanya

# ~/.config/starship.toml

[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
style = 'bold blue'
symbol = '🅰 '
[aws.region_aliases]
ap-southeast-2 = 'au'
us-east-1 = 'va'
[aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz'

Menampilkan region

# ~/.config/starship.toml

[aws]
format = 'on [$symbol$region]($style) '
style = 'bold blue'
symbol = '🅰 '
[aws.region_aliases]
ap-southeast-2 = 'au'
us-east-1 = 'va'

Menampilkan profil

# ~/.config/starship.toml

[aws]
format = 'on [$symbol$profile]($style) '
style = 'bold blue'
symbol = '🅰 '
[aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**'

Azure

The azure module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the ~/.azure/azureProfile.json file.

Opsi

Variabel	Bawaan	Deskripsi
format	'on [$symbol($subscription)]($style) '	The format for the Azure module to render.
symbol	'󰠅 '	The symbol used in the format.
style	'blue bold'	The style used in the format.
disabled	true	Disables the azure module.
subscription_aliases	{}	Table of subscription name aliases to display in addition to Azure subscription name.

Contoh

Display Subscription Name

# ~/.config/starship.toml

[azure]
disabled = false
format = 'on [$symbol($subscription)]($style) '
symbol = '󰠅 '
style = 'blue bold'

Display Username

# ~/.config/starship.toml

[azure]
disabled = false
format = "on [$symbol($username)]($style) "
symbol = "󰠅 "
style = "blue bold"

Display Subscription Name Alias

# ~/.config/starship.toml

[azure.subscription_aliases]
very-long-subscription-name = 'vlsn'

Baterai

Modul battery menampilkan seberapa penuh baterai perangkat terisi dan status pengisiannya. Modulnya hanya dapat terlihat ketika baterai perangkat di bawah 10%.

Opsi

Opsi	Bawaan	Deskripsi
full_symbol	'󰁹 '	Simbol dimunculkan ketika baterai penuh.
charging_symbol	'󰂄 '	Simbol dimunculkan ketika baterai mengisi.
discharging_symbol	'󰂃 '	Simbol dimunculkan ketika baterai terpakai.
unknown_symbol	'󰁽 '	Simbol dimunculkan ketika keadaan baterai tidak dikenali.
empty_symbol	'󰂎 '	Simbol dimunculkan ketika keadaan baterai kosong.
format	'[$symbol$percentage]($style) '	Format dari modul.
display	link	Menampilkan ambang dan gaya dari modul.
disabled	false	Menonaktifkan modul baterai.

Contoh

# ~/.config/starship.toml

[battery]
full_symbol = '🔋 '
charging_symbol = '⚡️ '
discharging_symbol = '💀 '

Tampilan Baterai

Opsi konfigurasi display digunakan untuk menentukan kapan indikator baterai harus ditampilkan (threshold), simbol mana yang akan digunakan (symbol), dan bagaimana seharusnya itu terlihat (style). Jika tidak ada display yang diberikan. Aturannya seperti yang ditunjukkan:

[[battery.display]]
threshold = 10
style = 'bold red'

Nilai bawaan untuk opsi charging_symbol dan discharging_symbol adalah nilai dari masing-masing opsi charging_symbol dan discharging_symbol dari nilai battery.

Opsi

Opsi dari display merupakan sebuah array dari tabel berikut.

Opsi	Bawaan	Deskripsi
threshold	10	The upper bound for the display option.
style	'red bold'	The style used if the display option is in use.
charging_symbol		Simbol opsional ditampilan jika opsi tampilan sedang digunakan, bawaan untuk opsi charging_symbol dari baterai.
discharging_symbol		Simbol opsional ditampilan jika opsi tampilan sedang digunakan, bawaan untuk opsi discharging_symbol dari baterai.

Contoh

[[battery.display]] # 'bold red' style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
style = 'bold red'

[[battery.display]] # 'bold yellow' style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
style = 'bold yellow'
discharging_symbol = '💦'

# when capacity is over 30%, the battery indicator will not be displayed

Buf

The buf module shows the currently installed version of Buf. By default, the module is shown if all of the following conditions are met:

• The buf CLI is installed.
• The current directory contains a buf.yaml, buf.gen.yaml, or buf.work.yaml configuration file.

Opsi

Opsi	Bawaan	Deskripsi
format	'with [$symbol($version )]($style)'	The format for the buf module.
version_format	'v${raw}'	Format dari versi.
symbol	'🐃 '	The symbol used before displaying the version of Buf.
detect_extensions	[]	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['buf.yaml', 'buf.gen.yaml', 'buf.work.yaml']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	'bold blue'	Gaya penataan untuk modul.
disabled	false	Menonaktifkan modul elixir.

Variabel

Variabel	Contoh	Deskripsi
version	v1.0.0	The version of buf
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[buf]
symbol = '🦬 '

Bun

The bun module shows the currently installed version of the bun JavaScript runtime. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• Direktori ini memiliki berkas bun.lockb
• Direktori ini memiliki berkas bunfig.toml

Opsi

Opsi	Bawaan	Deskripsi
format	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'🍞 '	A format string representing the symbol of Bun.
detect_extensions	[]	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['bun.lockb', 'bunfig.toml']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	'bold red'	Gaya penataan untuk modul.
disabled	false	Disables the bun module.

Variabel

Variabel	Contoh	Deskripsi
version	v0.1.4	The version of bun
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[bun]
format = 'via [🍔 $version](bold green) '

C

The c module shows some information about your C compiler. By default the module will be shown if the current directory contains a .c or .h file.

Opsi

Opsi	Bawaan	Deskripsi
format	'via [$symbol($version(-$name) )]($style)'	The format string for the module.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'C '	The symbol used before displaying the compiler details
detect_extensions	['c', 'h']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	[]	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
commands	[ [ 'cc', '--version' ], [ 'gcc', '--version' ], [ 'clang', '--version' ] ]	How to detect what the compiler is
style	'bold 149'	Gaya penataan untuk modul.
disabled	false	Disables the c module.

Variabel

Variabel	Contoh	Deskripsi
name	clang	The name of the compiler
version	13.0.0	The version of the compiler
symbol		Menyalin nilai dari opsi symbol
style		Menyalin nilai dari opsi style

NB that version is not in the default format.

Commands

The commands option accepts a list of commands to determine the compiler version and name.

Each command is represented as a list of the executable name, followed by its arguments, usually something like ['mycc', '--version']. Starship will try executing each command until it gets a result on STDOUT.

If a C compiler is not supported by this module, you can request it by raising an issue on GitHub.

Contoh

# ~/.config/starship.toml

[c]
format = 'via [$name $version]($style)'

Karakter

Modul character menampilkan sebuah karakter (biasanya anak panah) di samping teks pada terminalmu.

Karakter dapat memberitahu kamu apakah perintah terakhir berhasil atau tidak. Karakter dapat memberitahumu dengan dua cara ini:

• mengganti warna (red/green)
• mengganti bentuk (❯/✖)

Secara bawaan karakter hanya dapat mengganti warna. Jika kamu juga ingin mengganti bentuknya, perhatikan contoh berikut.

::: warning

vimcmd_symbol is only supported in cmd, fish and zsh. vimcmd_replace_one_symbol, vimcmd_replace_symbol, and vimcmd_visual_symbol are only supported in fish due to upstream issues with mode detection in zsh.

:::

Opsi

Opsi	Bawaan	Deskripsi
format	'$symbol '	Format string yang digunakan sebelum masukan teks.
success_symbol	'[❯](bold green)'	Format string yang digunakan sebelum masukan teks jika perintah sebelumnya berhasil.
error_symbol	'[❯](bold red)'	Format string yang digunakan sebelum masukan teks jika perintah sebelumnya gagal.
vimcmd_symbol	'[❮](bold green)'	Format string yang digunakan sebelum masukan teks jika shell sedang dalam vim dengan mode normal.
vimcmd_replace_one_symbol	'[❮](bold purple)'	The format string used before the text input if the shell is in vim replace_one mode.
vimcmd_replace_symbol	'[❮](bold purple)'	The format string used before the text input if the shell is in vim replace mode.
vimcmd_visual_symbol	'[❮](bold yellow)'	The format string used before the text input if the shell is in vim visual mode.
disabled	false	Menonaktifkan module character.

Variabel

Variabel	Contoh	Deskripsi
symbol		A mirror of either success_symbol, error_symbol, vimcmd_symbol or vimcmd_replace_one_symbol etc.

Contoh

Dengan menggunakan corak eror yang dikustomisasi

# ~/.config/starship.toml

[character]
success_symbol = '[➜](bold green) '
error_symbol = '[✗](bold red) '

Tanpa menggunakan corak eror yang dikustomisasi

# ~/.config/starship.toml

[character]
success_symbol = '[➜](bold green) '
error_symbol = '[➜](bold red) '

Dengan menggunakan corak vim yang dikustomisasi

# ~/.config/starship.toml

[character]
vimcmd_symbol = '[V](bold green) '

CMake

Modul cmake menampilkan versi terkini dari CMake yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• Direktori terkini yang berisikan sebuah file CMakeLists.txt
• Direktori terkini yang berisikan sebuah file CMakeCache.txt

Opsi

Opsi	Bawaan	Deskripsi
format	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'△ '	Simbol yang digunakan sebelum versi cmake.
detect_extensions	[]	Ekstensi mana yang sebaiknya memicu modul ini
detect_files	['CMakeLists.txt', 'CMakeCache.txt']	filenames mana yang sebaiknya memicu modul ini
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini
style	'bold blue'	Gaya penataan untuk modul.
disabled	false	Menonaktifkan modul cmake.

Variabel

Variabel	Contoh	Deskripsi
version	v3.17.3	Versi dari cmake
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

COBOL / GNUCOBOL

The cobol module shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met:

• The current directory contains any files ending in .cob or .COB
• The current directory contains any files ending in .cbl or .CBL

Opsi

Opsi	Bawaan	Deskripsi
symbol	'⚙️ '	The symbol used before displaying the version of COBOL.
format	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
style	'bold blue'	Gaya penataan untuk modul.
detect_extensions	['cbl', 'cob', 'CBL', 'COB']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	[]	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
disabled	false	Disables the cobol module.

Variabel

Variabel	Contoh	Deskripsi
version	v3.1.2.0	The version of cobol
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Durasi Perintah

Modul cmd_duration menampilkan seberapa lama perintah sebelumnya membutuhkan waktu untuk dilaksanakan. Modulnya hanya akan ditampilkan jika perintahnya membutuhkan waktu lebih dari dua detik, atau ada nilai dari konfigurasi min_time.

::: warning lakukan hook DEBUG trap dalam Bash

Jia kamu menjalankan Starship di bash, jangan lakukan hook DEBUG trap setelah menjalankan eval $(starship init $0), atau modulnya akan rusak.

:::

Pengguna Bash yang membutuhkan fungsi seperti preexec dapat menggunakan kerangka kerja bash_preexec dari rcaloras. Cukup dengan membuat array preexec_functions dan precmd_functions sebelum menjalankan eval $(starship init $0), lalu lanjutkan seperti biasa.

Opsi

Opsi	Bawaan	Deskripsi
min_tim	2_000	Durasi terpendek untuk menampilkan waktu (dalam milidetik).
show_milliseconds	false	Tampilkan milidetik sebagai ganti detik untuk durasinya.
format	'took [$duration]($style) '	Format dari modul.
style	'bold yellow'	Gaya penataan untuk modul.
disabled	false	Menonaktifkan modul cmd_duration.
show_notifications	false	Menampilkan notifikasi layar ketika perintah selesai.
min_time_to_notify	45_000	Durasi terpendek untuk menampilkan notifikasi (dalam milidetik).
notification_timeout		Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option.

Variabel

Variabel	Contoh	Deskripsi
duration	16m40s	Waktu yang dibutuhkan untuk menyelesaikan perintah
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[cmd_duration]
min_time = 500
format = 'underwent [$duration](bold yellow)'

Conda

The conda module shows the current Conda environment, if $CONDA_DEFAULT_ENV is set.

::: tip

Hal ini tidak menahan pengubah (modifier) prompt dari conda sendiri, kamu mungkin bisa menjalankan conda config --set changeps1 False.

:::

Opsi

Opsi	Bawaan	Deskripsi
truncation_length	1	Jumlah direktori yang dipotong oleh environment path, jika environment-nya dibuat melalui conda create -p [path]. 0 artinya tidak ada potongan. Lihat juga modul directory.
symbol	'🅒 '	Simbol yang digunakan sebelum nama environment.
style	'bold green'	Gaya penataan untuk modul.
format	'via [$symbol$environment]($style) '	Format dari modul.
ignore_base	true	Mengabaikan base environment saat aktif.
disabled	false	Menonaktifkan modul conda.

Variabel

Variabel	Contoh	Deskripsi
environment	astronauts	Environment conda saat ini
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[conda]
format = '[$symbol$environment](dimmed green) '

Container

The container module displays a symbol and container name, if inside a container.

Opsi

Opsi	Bawaan	Deskripsi
symbol	'⬢'	The symbol shown, when inside a container
style	'bold red dimmed'	Gaya penataan untuk modul.
format	'[$symbol \[$name\]]($style) '	Format dari modul.
disabled	false	Disables the container module.

Variabel

Variabel	Contoh	Deskripsi
name	fedora-toolbox:35	The name of the container
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[container]
format = '[$symbol \[$name\]]($style) '

Crystal

Modul crystal menampilkan versi terkini dari Crystal yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• Direktori terkini yang berisikan sebuah file shard.yml
• Direktori terkini yang berisikan sebuah file .cr

Opsi

Opsi	Bawaan	Deskripsi
symbol	'🔮 '	Simbol yang digunakan sebelum menampilkan versi crystal terkini.
format	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
style	'bold red'	Gaya penataan untuk modul.
detect_extensions	['cr']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['shard.yml']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
disabled	false	Menonaktifkan modul crystal.

Variabel

Variabel	Contoh	Deskripsi
version	v0.32.1	Versi dari crystal
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[crystal]
format = 'via [✨ $version](bold blue) '

Daml

The daml module shows the currently used Daml SDK version when you are in the root directory of your Daml project. The sdk-version in the daml.yaml file will be used, unless it's overridden by the DAML_SDK_VERSION environment variable. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• Direktori ini memiliki berkas daml.yaml

Opsi

Opsi	Bawaan	Deskripsi
format	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'Λ '	A format string representing the symbol of Daml
style	'bold cyan'	Gaya penataan untuk modul.
detect_extensions	[]	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['daml.yaml']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
disabled	false	Disables the daml module.

Variabel

Variabel	Contoh	Deskripsi
version	v2.2.0	The version of daml
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[daml]
format = 'via [D $version](bold bright-green) '

Dart

Modul dart menampilkan versi terkini dari Dart yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• Direktori terkini yang berisikan sebuah file berekstensi .dart
• Direktori terkini yang berisikan sebuah direktori dart_tool
• Direktori terkini yang berisikan sebuah file pubspec.yaml, pubspec.yml atau pubspec.lock

Opsi

Opsi	Bawaan	Deskripsi
format	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'🎯 '	Sebuah format string yang melambangkan simbol Dart
detect_extensions	['dart']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['pubspec.yaml', 'pubspec.yml', 'pubspec.lock']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	['.dart_tool']	Folder mana yang sebaiknya memicul modul ini.
style	'bold blue'	Gaya penataan untuk modul.
disabled	false	Menonaktifkan modul dart.

Variabel

Variabel	Contoh	Deskripsi
version	v2.8.4	Versi dari dart
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[dart]
format = 'via [🔰 $version](bold red) '

Deno

Modul deno menampilkan versi terkini dari Deno yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• The current directory contains a deno.json, deno.jsonc, mod.ts, mod.js, deps.ts or deps.js file

Opsi

Opsi	Bawaan	Deskripsi
format	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'🦕 '	Sebuah format string yang melambangkan simbol Deno
detect_extensions	[]	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['deno.json', 'deno.jsonc', 'mod.ts', 'mod.js', 'deps.ts', 'deps.js']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	'green bold'	Gaya penataan untuk modul.
disabled	false	Menonaktifkan modul deno.

Variabel

Variabel	Contoh	Deskripsi
version	v1.8.3	Versi dari deno
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

Contoh

# ~/.config/starship.toml

[deno]
format = 'via [🦕 $version](green bold) '

Direktori

Modul directory menampilkan arah ke direkori terkinimu, disingkat ke tiga folder induk. Direkrotimu juga akan disingkat ke root dari git repo di tempatmu berada saat ini.

When using the fish_style_pwd_dir_length option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option.

Sebagai contoh, untuk ~/Dev/Nix/nixpkgs/pkgs dimana nixpkgs merupakan root repo-nya, dan lalu opsinya diset menjadi 1. Kamu akan melihat ~/D/N/nixpkgs/pkgs, sedangkan sebelumnya direktori tersebut harusnya nixpkgs/pkgs.

Opsi

Opsi	Bawaan	Deskripsi
truncation_length	3	Jumlah dari folder induk yang harusnya disingkat oleh direktori saat ini.
truncate_to_repo	true	Apakah harus menyingkat root dari git repo tempatmu berada saat ini.
format	'[$path]($style)[$read_only]($read_only_style) '	Format dari modul.
style	'bold cyan'	Gaya penataan untuk modul.
disabled	false	Menonaktifkan modul directory.
read_only	'🔒'	Simbol yang mengindikasikan direktori saat ini bersifat read only.
read_only_style	'red'	Corak gaya untuk simbol read only.
truncation_symbol	''	Simbol untuk awalan jalur yang disingkat. eg: '…/'
before_repo_root_style		The style for the path segment above the root of the git repo. The default value is equivalent to style.
repo_root_style		The style for the root of the git repo. The default value is equivalent to style.
repo_root_format	'[$before_root_path]($before_repo_root_style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) '	The format of a git repo when before_repo_root_style and repo_root_style is defined.
home_symbol	'~'	Simbol yang mengindikasikan direktori home.
use_os_path_sep	true	Use the OS specific path separator instead of always using / (e.g. \ on Windows)

Modul ini memilki beberapa opsi konfigurasi lanjutan yang mengontrol bagaimana direktori ditampilkan.

Advanced Option	Bawaan	Deskripsi
substitutions		A table of substitutions to be made to the path.
fish_style_pwd_dir_length	0	The number of characters to use when applying fish shell pwd path logic.
use_logical_path	true	If true render the logical path sourced from the shell via PWD or --logical-path. If false instead render the physical filesystem path with symlinks resolved.

substitutions allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.

[directory.substitutions]
'/Volumes/network/path' = '/net'
'src/com/long/java/path' = 'mypath'

fish_style_pwd_dir_length interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path /built/this/city/on/rock/and/roll, which would normally be displayed as rock/and/roll, would be displayed as /b/t/c/o/rock/and/roll with fish_style_pwd_dir_length = 1--the path components that would normally be removed are displayed with a single character. For fish_style_pwd_dir_length = 2, it would be /bu/th/ci/on/rock/and/roll.

Variabel

Variabel	Contoh	Deskripsi
path	'D:/Projects'	Direktori terkini
style*	'black bold dimmed'	Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

The git repos have additional variables.

Let us consider the path /path/to/home/git_repo/src/lib

Variabel	Contoh	Deskripsi
before_root_path	'/path/to/home/'	The path before git root directory path
repo_root	'git_repo'	The git root directory name
path	'/src/lib'	The remaining path
style	'black bold dimmed'	Menyalin nilai dari opsi style
repo_root_style	'underline white'	Style for git root directory name

Contoh

# ~/.config/starship.toml

[directory]
truncation_length = 8
truncation_symbol = '…/'

Docker Context

The docker_context module shows the currently active Docker context if it's not set to default or if the DOCKER_MACHINE_NAME, DOCKER_HOST or DOCKER_CONTEXT environment variables are set (as they are meant to override the context in use).

Opsi

Opsi	Bawaan	Deskripsi
format	'via [$symbol$context]($style) '	Format dari modul.
symbol	'🐳 '	Simbol yang digunakan sebelum menampilkan Docker context.
only_with_files	true	Hanya ditampilkan jika terdapat kecocokan
detect_extensions	[]	Extensions mana yang harusnya memicu modul (butuh only_with_files untuk diset true).
detect_files	['docker-compose.yml', 'docker-compose.yaml', 'Dockerfile']	filenames mana yang harusnya memicu modul ini (butuh only_with_files untuk diset true).
detect_folders	[]	Folder mana yang harusnya memicu modul (butuh only_with_files untuk diset true).
style	'blue bold'	Gaya penataan untuk modul.
disabled	false	Menonaktifkan module docket_context.

Variabel

Variabel	Contoh	Deskripsi
context	test_context	Docker context terkini
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[docker_context]
format = 'via [🐋 $context](blue bold)'

Dotnet

Modul dotnet menampilkan informasi terkait versi dari .NET Core SDK pada direktori terkini. Apabila SDK telah disematkan pada direktori terkni, maka veri yang telah disematkan tersebutlah yang ditampilkan. Jika tidak, maka modul akan menampilkan versi SDK terkini.

Secara bawaan, modul ini hanya akan ditampilkan ke prompt kamu ketika teradapat satu atau lebih file berikut di dalam direktorimu saat ini:

• global.json
• project.json
• Directory.Build.props
• Directory.Build.targets
• Packages.props
• *.csproj
• *.fsproj
• *.xproj

Kamu juga perlu memasang .NET Core SDK untuk menggunakannya dengan baik.

Secara internal, modul ini menggunakan mekenasimenya sendiri untuk melakukan pendeteksian versi. Biasanya, hal ini dua kali lebih cepat seperti untuk menjalankan dotnet --version, tetapi ada kemungkinan hal ini akan menampilkan versi yang salah jika proyek .NET milikmu memiliki tata letak direktori yang tidak biasa. Jika menurutmu akurasi lebih penting dari kecepatan, kamu dapat menonaktifkan mekanisme tersebut dengan mengatur heuristic = false di dalam opsi modul.

The module will also show the Target Framework Moniker (https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-frameworks) when there is a .csproj file in the current directory.

Opsi

Opsi	Bawaan	Deskripsi
format	'via [$symbol($version )(🎯 $tfm )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'.NET '	Simbol yang digunakan sebelum menampilkan versi dotnet terkini.
heuristic	true	Menggunakan versi yang lebih cepat untuk membuat starship tetap trendi.
detect_extensions	['csproj', 'fsproj', 'xproj']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['global.json', 'project.json', 'Directory.Build.props', 'Directory.Build.targets', 'Packages.props']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	'bold blue'	Gaya penataan untuk modul.
disabled	false	Menonaktifkan modul dotnet.

Variabel

Variabel	Contoh	Deskripsi
version	v3.1.201	Versi dari sdk dotnet
tfm	netstandard2.0	Target Framework Moniket yang tengah ditarget starship
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[dotnet]
symbol = '🥅 '
style = 'green'
heuristic = false

Elixir

Modul elixir menampilkan versi terkini dari Elixir dan Erlang/OTP. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• Direktori terkini yang berisikan sebuah file mix.exs.

Opsi

Opsi	Bawaan	Deskripsi
format	'via [$symbol($version \(OTP $otp_version\) )]($style)'	Format dari modul elixir.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'💧 '	Simbol yang digunakan sebelum menampilkan versi Elixir/Erlang terkini.
detect_extensions	[]	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['mix.exs']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	'bold purple'	Gaya penataan untuk modul.
disabled	false	Menonaktifkan modul elixir.

Variabel

Variabel	Contoh	Deskripsi
version	v1.10	Versi dari elixir
otp_version		Versi otp dari elixir
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[elixir]
symbol = '🔮 '

Elm

Modul elixir menampilkan versi terkini dari Elm yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• Direktori terkini yang berisikan sebuah file elm.json
• Direktori terkini yang berisikan sebuah file elm-package.json
• Direktori terkini yang berisikan sebuah file elm-version
• Direktori terkini yang berisikan sebuah folderelm-stuff
• The current directory contains *.elm files

Opsi

Opsi	Bawaan	Deskripsi
format	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'🌳 '	Sebuah format string yang melambangkan simbol Elm.
detect_extensions	['elm']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['elm.json', 'elm-package.json', '.elm-version']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	['elm-stuff']	Folder mana yang sebaiknya memicul modul ini.
style	'cyan bold'	Gaya penataan untuk modul.
disabled	false	Menonaktifkan modul elm.

Variabel

Variabel	Contoh	Deskripsi
version	v0.19.1	Versi dari elm
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[elm]
format = 'via [ $version](cyan bold) '

Variabel Environment

Modul env_var menampilkan nilai terkini dari variabel environment yang dipilih. Modul hanya akan aktif jika beberapa syarat berikut telah terpenuhi:

• Opsi konfigurasi variable cocok dengan variabel environment yang ada
• Opsi konfigurasi variable tidak didefinisikan, tapi opsi konfigurasi default yang didefinisikan

::: tip

The order in which env_var modules are shown can be individually set by including ${env_var.foo} in the top level format (as it includes a dot, you need to use ${...}). By default, the env_var module will simply show all env_var modules in the order they were defined.

:::

::: tip

Multiple environmental variables can be displayed by using a .. (lihat contoh) Jika opsi konfigurasi variable tidak diset, modul akan menampilkan nilai variabel di bawah teks nama setelah karakter ..

Contoh: konfigurasi berikut akan menampilkan nilai dari variabel USER environment

# ~/.config/starship.toml

[env_var.USER]
default = 'unknown user'

:::

Opsi

Opsi	Bawaan	Deskripsi
symbol	""	Simbol yang digunakan sebelum menampilkan nilai dari variabel.
variabel		Variabel environment yang akan ditampilkan.
bawaan		Nilai bawaan yang akan ditampilkan ketika variabel yang terpilih tidak didefinisikan.
format	"with [$env_value]($style) "	Format dari modul.
deskripsi	"<env_var module>"	The description of the module that is shown when running starship explain.
disabled	false	Menonaktifkan modul env_var.

Variabel

Variabel	Contoh	Deskripsi
env_value	Windows NT (jika variable akan menjadi $OS)	Nilai environment dari opsi variable
symbol		Menyalin nilai dari opsi symbol
style*	black bold dimmed	Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[env_var]
variable = 'SHELL'
default = 'unknown shell'

Menampilkan multi-variabel environment:

# ~/.config/starship.toml

[env_var.SHELL]
variable = 'SHELL'
default = 'unknown shell'
[env_var.USER]
default = 'unknown user'

Erlang

The erlang module shows the currently installed version of Erlang/OTP. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• Direktori ini memiliki berkas rebar.config.
• Direktori ini memiliki berkas erlang.mk.

Opsi

Opsi	Bawaan	Deskripsi
format	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	' '	The symbol used before displaying the version of erlang.
style	'bold red'	Gaya penataan untuk modul.
detect_extensions	[]	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['rebar.config', 'elang.mk']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
disabled	false	Disables the erlang module.

Variabel

Variabel	Contoh	Deskripsi
version	v22.1.3	The version of erlang
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[erlang]
format = 'via [e $version](bold red) '

Fennel

The fennel module shows the currently installed version of Fennel. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• The current directory contains a file with the .fnl extension

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'🧅 '	The symbol used before displaying the version of fennel.
style	'bold green'	Gaya penataan untuk modul.
detect_extensions	[fnl]	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	[]	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
disabled	false	Disables the fennel module.

Variabel

Variabel	Contoh	Deskripsi
version	v1.2.1	The version of fennel
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[fennel]
symbol = '⫰ '

Fill

The fill module fills any extra space on the line with a symbol. If multiple fill modules are present in a line they will split the space evenly between them. This is useful for aligning other modules.

Opsi

Opsi	Bawaan	Deskripsi
symbol	'.'	The symbol used to fill the line.
style	'bold black'	Gaya penataan untuk modul.
disabled	false	Disables the fill module

Contoh

# ~/.config/starship.toml
format = 'AA $fill BB $fill CC'

[fill]
symbol = '-'
style = 'bold green'

Produces a prompt that looks like:

AA -------------------------------------------- BB -------------------------------------------- CC

Fossil Branch

The fossil_branch module shows the name of the active branch of the check-out in your current directory.

Opsi

Opsi	Bawaan	Deskripsi
fromat	'on [$symbol$branch]($style) '	Format dari modul. Use '$branch' to refer to the current branch name.
symbol	' '	The symbol used before the branch name of the check-out in your current directory.
style	'bold purple'	Gaya penataan untuk modul.
truncation_length	2^63 - 1	Truncates a Fossil branch name to N graphemes
truncation_symbol	'…'	The symbol used to indicate a branch name was truncated. You can use '' for no symbol.
disabled	true	Disables the fossil_branch module.

Variabel

Variabel	Contoh	Deskripsi
branch	trunk	The active Fossil branch
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[fossil_branch]
symbol = '🦎 '
truncation_length = 4
truncation_symbol = ''

Fossil Metrics

The fossil_metrics module will show the number of added and deleted lines in the check-out in your current directory. At least v2.14 (2021-01-20) of Fossil is required.

Opsi

Opsi	Bawaan	Deskripsi
fromat	'([+$added]($added_style) )([-$deleted]($deleted_style) )'	Format dari modul.
added_style	'bold green'	The style for the added count.
deleted_style	'bold red'	The style for the deleted count.
only_nonzero_diffs	true	Render status only for changed items.
disabled	true	Disables the fossil_metrics module.

Variabel

Variabel	Contoh	Deskripsi
added	1	The current number of added lines
deleted	2	The current number of deleted lines
added_style*		Mirrors the value of option added_style
deleted_style*		Mirrors the value of option deleted_style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[fossil_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '

Google Cloud (gcloud)

The gcloud module shows the current configuration for gcloud CLI. This is based on the ~/.config/gcloud/active_config file and the ~/.config/gcloud/configurations/config_{CONFIG NAME} file and the CLOUDSDK_CONFIG env var.

When the module is enabled it will always be active, unless detect_env_vars has been set in which case the module will only be active be active when one of the environment variables has been set.

Opsi

Opsi	Bawaan	Deskripsi
fromat	'on [$symbol$account(@$domain)(\($region\))]($style) '	Format dari modul.
symbol	'☁️ '	The symbol used before displaying the current GCP profile.
region_aliases	{}	Table of region aliases to display in addition to the GCP name.
project_aliases	{}	Table of project aliases to display in addition to the GCP name.
detect_env_vars	[]	Which environmental variables should trigger this module
style	'bold blue'	Gaya penataan untuk modul.
disabled	false	Disables the gcloud module.

Variabel

Variabel	Contoh	Deskripsi
region	us-central1	The current GCP region
account	foo	The current GCP profile
domain	example.com	The current GCP profile domain
project		The current GCP project
active	bawaan	The active config name written in ~/.config/gcloud/active_config
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

Display account and project

# ~/.config/starship.toml

[gcloud]
format = 'on [$symbol$account(@$domain)(\($project\))]($style) '

Display active config name only

# ~/.config/starship.toml

[gcloud]
format = '[$symbol$active]($style) '
style = 'bold yellow'

Display account and aliased region

# ~/.config/starship.toml

[gcloud]
symbol = '️🇬️ '
[gcloud.region_aliases]
us-central1 = 'uc1'
asia-northeast1 = 'an1'

Display account and aliased project

# ~/.config/starship.toml

[gcloud]
format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
[gcloud.project_aliases]
very-long-project-name = 'vlpn'

Git Branch

The git_branch module shows the active branch of the repo in your current directory.

Opsi

Opsi	Bawaan	Deskripsi
always_show_remote	false	Shows the remote tracking branch name, even if it is equal to the local branch name.
fromat	'on [$symbol$branch(:$remote_branch)]($style) '	Format dari modul. Use '$branch' to refer to the current branch name.
symbol	' '	A format string representing the symbol of git branch.
style	'bold purple'	Gaya penataan untuk modul.
truncation_length	2^63 - 1	Truncates a git branch to N graphemes.
truncation_symbol	'…'	The symbol used to indicate a branch name was truncated. You can use '' for no symbol.
only_attached	false	Only show the branch name when not in a detached HEAD state.
ignore_branches	[]	A list of names to avoid displaying. Useful for 'master' or 'main'.
disabled	false	Disables the git_branch module.

Variabel

Variabel	Contoh	Deskripsi
branch	master	The current branch name, falls back to HEAD if there's no current branch (e.g. git detached HEAD).
remote_name	origin	The remote name.
remote_branch	master	The name of the branch tracked on remote_name.
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[git_branch]
symbol = '🌱 '
truncation_length = 4
truncation_symbol = ''
ignore_branches = ['master', 'main']

Git Commit

The git_commit module shows the current commit hash and also the tag (if any) of the repo in your current directory.

Opsi

Opsi	Bawaan	Deskripsi
commit_hash_length	7	The length of the displayed git commit hash.
fromat	'[\($hash$tag\)]($style) '	Format dari modul.
style	'bold green'	Gaya penataan untuk modul.
only_detached	true	Only show git commit hash when in detached HEAD state
tag_disabled	true	Disables showing tag info in git_commit module.
tag_max_candidates	0	How many commits to consider for tag display. The default only allows exact matches.
tag_symbol	' 🏷 '	Tag symbol prefixing the info shown
disabled	false	Disables the git_commit module.

Variabel

Variabel	Contoh	Deskripsi
hash	b703eb3	The current git commit hash
tag	v1.0.0	The tag name if showing tag info is enabled.
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[git_commit]
commit_hash_length = 4
tag_symbol = '🔖 '

Git State

The git_state module will show in directories which are part of a git repository, and where there is an operation in progress, such as: REBASING, BISECTING, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too.

Opsi

Opsi	Bawaan	Deskripsi
rebase	'REBASING'	A format string displayed when a rebase is in progress.
merge	'MERGING'	A format string displayed when a merge is in progress.
revert	'REVERTING'	A format string displayed when a revert is in progress.
cherry_pick	'CHERRY-PICKING'	A format string displayed when a cherry-pick is in progress.
bisect	'BISECTING'	A format string displayed when a bisect is in progress.
am	'AM'	A format string displayed when an apply-mailbox (git am) is in progress.
am_or_rebase	'AM/REBASE'	A format string displayed when an ambiguous apply-mailbox or rebase is in progress.
style	'bold yellow'	Gaya penataan untuk modul.
fromat	'\([$state( $progress_current/$progress_total)]($style)\) '	Format dari modul.
disabled	false	Disables the git_state module.

Variabel

Variabel	Contoh	Deskripsi
state	REBASING	The current state of the repo
progress_current	1	The current operation progress
progress_total	2	The total operation progress
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[git_state]
format = '[\($state( $progress_current of $progress_total)\)]($style) '
cherry_pick = '[🍒 PICKING](bold red)'

Git Metrics

The git_metrics module will show the number of added and deleted lines in the current git repository.

::: tip

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Opsi

Opsi	Bawaan	Deskripsi
added_style	'bold green'	The style for the added count.
deleted_style	'bold red'	The style for the deleted count.
only_nonzero_diffs	true	Render status only for changed items.
fromat	'([+$added]($added_style) )([-$deleted]($deleted_style) )'	Format dari modul.
disabled	true	Disables the git_metrics module.
ignore_submodules	false	Ignore changes to submodules

Variabel

Variabel	Contoh	Deskripsi
added	1	The current number of added lines
deleted	2	The current number of deleted lines
added_style*		Mirrors the value of option added_style
deleted_style*		Mirrors the value of option deleted_style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[git_metrics]
added_style = 'bold blue'
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '

Git Status

The git_status module shows symbols representing the state of the repo in your current directory.

::: tip

The Git Status module is very slow in Windows directories (for example under /mnt/c/) when in a WSL environment. You can disable the module or use the windows_starship option to use a Windows-native Starship executable to compute git_status for those paths.

:::

Opsi

Opsi	Bawaan	Deskripsi
fromat	'([\[$all_status$ahead_behind\]]($style) )'	The default format for git_status
conflicted	'='	This branch has merge conflicts.
ahead	'⇡'	The format of ahead
behind	'⇣'	The format of behind
diverged	'⇕'	The format of diverged
up_to_date	''	The format of up_to_date
untracked	'?'	The format of untracked
stashed	'$'	The format of stashed
modified	'!'	The format of modified
staged	'+'	The format of staged
renamed	'»'	The format of renamed
deleted	'✘'	The format of deleted
typechanged	""	The format of typechange
style	'bold red'	Gaya penataan untuk modul.
ignore_submodules	false	Ignore changes to submodules.
disabled	false	Disables the git_status module.
windows_starship		Use this (Linux) path to a Windows Starship executable to render git_status when on Windows paths in WSL.

Variabel

The following variables can be used in format:

Variabel	Deskripsi
all_status	Shortcut for$conflicted$stashed$deleted$renamed$modified$staged$untracked
ahead_behind	Displays diverged, ahead, behind or up_to_date format string based on the current status of the repo.
conflicted	Displays conflicted when this branch has merge conflicts.
untracked	Displays untracked when there are untracked files in the working directory.
stashed	Displays stashed when a stash exists for the local repository.
modified	Displays modified when there are file modifications in the working directory.
staged	Displays staged when a new file has been added to the staging area.
renamed	Displays renamed when a renamed file has been added to the staging area.
deleted	Displays deleted when a file's deletion has been added to the staging area.
typechanged	Displays typechange when a file's type has been changed in the staging area.
style*	Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

The following variables can be used in diverged:

Variabel	Deskripsi
ahead_count	Number of commits ahead of the tracking branch
behind_count	Number of commits behind the tracking branch

The following variables can be used in conflicted, ahead, behind, untracked, stashed, modified, staged, renamed and deleted:

Variabel	Deskripsi
count	Show the number of files

Contoh

# ~/.config/starship.toml

[git_status]
conflicted = '🏳'
ahead = '🏎💨'
behind = '😰'
diverged = '😵'
up_to_date = '✓'
untracked = '🤷'
stashed = '📦'
modified = '📝'
staged = '[++\($count\)](green)'
renamed = '👅'
deleted = '🗑'

Show ahead/behind count of the branch being tracked

# ~/.config/starship.toml

[git_status]
ahead = '⇡${count}'
diverged = '⇕⇡${ahead_count}⇣${behind_count}'
behind = '⇣${count}'

Use Windows Starship executable on Windows paths in WSL

# ~/.config/starship.toml

[git_status]
windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.exe'

Go

The golang module shows the currently installed version of Go. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• Direktori ini memiliki berkas go.mod
• Direktori ini memiliki berkas go.sum
• Direktori ini memiliki berkas go.work
• Direktori ini memiliki berkas glide.yaml
• Direktori ini memiliki berkas Gopkg.yml
• Direktori ini memiliki berkas Gopkg.lock
• Direktori ini memiliki berkas .go-version
• Direktori ini memiliki berkas Godeps
• Direktori ini memiliki berkas dengan ekstensi .go

Opsi

Opsi	Bawaan	Deskripsi
format	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'🐹 '	A format string representing the symbol of Go.
detect_extensions	['go']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	['Godeps']	Folder mana yang sebaiknya memicul modul ini.
style	'bold cyan'	Gaya penataan untuk modul.
not_capable_style	'bold red'	The style for the module when the go directive in the go.mod file does not match the installed Go version.
disabled	false	Disables the golang module.

Variabel

Variabel	Contoh	Deskripsi
version	v1.12.1	The version of go
mod_version	1.16	go version requirement as set in the go directive of go.mod. Will only show if the version requirement does not match the go version.
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[golang]
format = 'via [🏎💨 $version](bold cyan) '

Using mod_version

# ~/.config/starship.toml

[golang]
format = 'via [$symbol($version )($mod_version )]($style)'

Guix-shell

The guix_shell module shows the guix-shell environment. The module will be shown when inside a guix-shell environment.

Opsi

Opsi	Bawaan	Deskripsi
format	'via [$symbol]($style) '	Format dari modul.
symbol	"🐃 "	A format string representing the symbol of guix-shell.
style	"yellow bold"	Gaya penataan untuk modul.
disabled	false	Disables the guix_shell module.

Variabel

Variabel	Contoh	Deskripsi
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[guix_shell]
disabled = true
format = 'via [🐂](yellow bold) '

Gradle

The gradle module shows the version of the Gradle Wrapper currently used in the project directory.

Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• The current directory contains a gradle/wrapper/gradle-wrapper.properties directory.
• The current directory contains a file ending with .gradle or .gradle.kts.

The gradle module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns.

Opsi

Opsi	Bawaan	Deskripsi
fromat	"via [$symbol($version )]($style)"	Format dari modul.
version_format	"v${raw}"	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	"🅶 "	A format string representing the symbol of Gradle.
detect_extensions	["gradle", "gradle.kts"]	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	[]	filenames mana yang sebaiknya memicu modul ini.
detect_folders	["gradle"]	Folder mana yang sebaiknya memicul modul ini.
style	"bold bright-cyan"	Gaya penataan untuk modul.
disabled	false	Disables the gradle module.
recursive	false	Enables recursive finding for the gradle directory.

Variabel

Variabel	Contoh	Deskripsi
version	v7.5.1	The version of gradle
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Haskell

The haskell module finds the current selected GHC version and/or the selected Stack snapshot.

Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• Direktori ini memiliki berkas stack.yaml
• The current directory contains any .hs, .cabal, or .hs-boot file

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
symbol	'λ '	A format string representing the symbol of Haskell
detect_extensions	['hs', 'cabal', 'hs-boot']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['stack.yaml', 'cabal.project']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	'bold purple'	Gaya penataan untuk modul.
disabled	false	Disables the haskell module.

Variabel

Variabel	Contoh	Deskripsi
version		ghc_version or snapshot depending on whether the current project is a Stack project
snapshot	lts-18.12	Currently selected Stack snapshot
ghc_version	9.2.1	Currently installed GHC version
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Haxe

The haxe module shows the currently installed version of Haxe. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• The current directory contains a project.xml, Project.xml, application.xml, haxelib.json, hxformat.json or .haxerc file
• The current directory contains a .haxelib or a haxe_libraries directory
• The current directory contains a file with the .hx or .hxml extension

Opsi

Opsi	Bawaan	Deskripsi
fromat	"via [$symbol($version )]($style)"	Format dari modul.
version_format	"v${raw}"	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
detect_extensions	["hx", "hxml"]	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[".haxelib", "haxe_libraries"]	Folder mana yang sebaiknya memicul modul ini.
symbol	"⌘ "	A format string representing the symbol of Helm.
style	"bold fg:202"	Gaya penataan untuk modul.
disabled	false	Disables the haxe module.

Variabel

Variabel	Contoh	Deskripsi
version	v4.2.5	The version of haxe
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[haxe]
format = "via [⌘ $version](bold fg:202) "

Helm

The helm module shows the currently installed version of Helm. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• Direktori ini memiliki berkas helmfile.yaml
• The current directory contains a Chart.yaml file

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
detect_extensions	[]	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['helmfile.yaml', 'Chart.yaml']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
symbol	'⎈ '	A format string representing the symbol of Helm.
style	'bold white'	Gaya penataan untuk modul.
disabled	false	Disables the helm module.

Variabel

Variabel	Contoh	Deskripsi
version	v3.1.1	The version of helm
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[helm]
format = 'via [⎈ $version](bold white) '

Hostname

The hostname module shows the system hostname.

Opsi

Opsi	Bawaan	Deskripsi
ssh_only	true	Only show hostname when connected to an SSH session.
ssh_symbol	'🌐 '	A format string representing the symbol when connected to SSH session.
trim_at	'.'	String that the hostname is cut off at, after the first match. '.' will stop after the first dot. '' will disable any truncation
fromat	'[$ssh_symbol$hostname]($style) in '	Format dari modul.
style	'bold dimmed green'	Gaya penataan untuk modul.
disabled	false	Disables the hostname module.

Variabel

Variabel	Contoh	Deskripsi
hostname	computer	The hostname of the computer
style*		Menyalin nilai dari opsi style
ssh_symbol	'🌏 '	The symbol to represent when connected to SSH session

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[hostname]
ssh_only = false
format = '[$ssh_symbol](bold blue) on [$hostname](bold red) '
trim_at = '.companyname.com'
disabled = false

Java

The java module shows the currently installed version of Java. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• The current directory contains a pom.xml, build.gradle.kts, build.sbt, .java-version, deps.edn, project.clj, build.boot, or .sdkmanrc file
• The current directory contains a file with the .java, .class, .gradle, .jar, .clj, or .cljc extension

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [${symbol}(${version} )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
detect_extensions	['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot', '.sdkmanrc']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
symbol	'☕ '	A format string representing the symbol of Java
style	'red dimmed'	Gaya penataan untuk modul.
disabled	false	Disables the java module.

Variabel

Variabel	Contoh	Deskripsi
version	v14	The version of java
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[java]
symbol = '🌟 '

Jobs

The jobs module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the number_threshold config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the symbol_threshold config value, if it exists. You can set both values to 0 in order to always show the symbol and number of jobs, even if there are 0 jobs running.

The default functionality is:

• 0 jobs -> Nothing is shown.
• 1 job -> symbol is shown.
• 2 jobs or more -> symbol + number are shown.

::: warning

This module is not supported on tcsh and nu.

:::

::: warning

The threshold option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the threshold config value, if it exists. If threshold is set to 0, then the module will also show when there are 0 jobs running.

:::

Opsi

Opsi	Bawaan	Deskripsi
threshold*	1	Show number of jobs if exceeded.
symbol_threshold	1	Show symbol if the job count is at least symbol_threshold.
number_threshold	2	Show the number of jobs if the job count is at least number_threshold.
fromat	'[$symbol$number]($style) '	Format dari modul.
symbol	'✦'	The string used to represent the symbol variable.
style	'bold blue'	Gaya penataan untuk modul.
disabled	false	Disables the jobs module.

*: This option is deprecated, please use the number_threshold and symbol_threshold options instead.

Variabel

Variabel	Contoh	Deskripsi
number	1	The number of jobs
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[jobs]
symbol = '+ '
number_threshold = 4
symbol_threshold = 0

Julia

The julia module shows the currently installed version of Julia. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• The current directory contains a Project.toml file
• The current directory contains a Manifest.toml file
• The current directory contains a file with the .jl extension

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
detect_extensions	['jl']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['Project.toml', 'Manifest.toml']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
symbol	'ஃ '	A format string representing the symbol of Julia.
style	'bold purple'	Gaya penataan untuk modul.
disabled	false	Disables the julia module.

Variabel

Variabel	Contoh	Deskripsi
version	v1.4.0	The version of julia
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[julia]
symbol = '∴ '

Kotlin

The kotlin module shows the currently installed version of Kotlin. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• The current directory contains a .kt or a .kts file

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
detect_extensions	['kt', 'kts']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	[]	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
symbol	'🅺 '	A format string representing the symbol of Kotlin.
style	'bold blue'	Gaya penataan untuk modul.
kotlin_binary	'kotlin'	Configures the kotlin binary that Starship executes when getting the version.
disabled	false	Disables the kotlin module.

Variabel

Variabel	Contoh	Deskripsi
version	v1.4.21	The version of kotlin
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[kotlin]
symbol = '🅺 '

# ~/.config/starship.toml

[kotlin]
# Uses the Kotlin Compiler binary to get the installed version
kotlin_binary = 'kotlinc'

Kubernetes

Displays the current Kubernetes context name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via kubectl config set-context starship-context --namespace astronaut. Similarly, the user and cluster can be set with kubectl config set-context starship-context --user starship-user and kubectl config set-context starship-context --cluster starship-cluster. If the $KUBECONFIG env var is set the module will use that if not it will use the ~/.kube/config.

::: tip

This module is disabled by default. To enable it, set disabled to false in your configuration file.

When the module is enabled it will always be active, unless any of detect_extensions, detect_files or detect_folders have been set in which case the module will only be active in directories that match those conditions.

:::

Opsi

::: warning

The context_aliases and user_aliases options are deprecated. Use contexts and the corresponding context_alias and user_alias options instead.

:::

Opsi	Bawaan	Deskripsi
symbol	'☸ '	A format string representing the symbol displayed before the Cluster.
fromat	'[$symbol$context( \($namespace\))]($style) in '	Format dari modul.
style	'cyan bold'	Gaya penataan untuk modul.
context_aliases*	{}	Table of context aliases to display.
user_aliases*	{}	Table of user aliases to display.
detect_extensions	[]	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	[]	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
contexts	[]	Customized styles and symbols for specific contexts.
disabled	true	Disables the kubernetes module.

*: This option is deprecated, please add contexts with the corresponding context_alias and user_alias options instead.

To customize the style of the module for specific environments, use the following configuration as part of the contexts list:

Variabel	Deskripsi
context_pattern	Required Regular expression to match current Kubernetes context name.
user_pattern	Regular expression to match current Kubernetes user name.
context_alias	Context alias to display instead of the full context name.
user_alias	User alias to display instead of the full user name.
style	The style for the module when using this context. If not set, will use module's style.
symbol	The symbol for the module when using this context. If not set, will use module's symbol.

Note that all regular expression are anchored with ^<pattern>$ and so must match the whole string. The *_pattern regular expressions may contain capture groups, which can be referenced in the corresponding alias via $name and $N (see example below and the rust Regex::replace() documentation).

Variabel

Variabel	Contoh	Deskripsi
context	starship-context	The current kubernetes context name
namespace	starship-namespace	If set, the current kubernetes namespace
user	starship-user	If set, the current kubernetes user
cluster	starship-cluster	If set, the current kubernetes cluster
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[kubernetes]
format = 'on [⛵ ($user on )($cluster in )$context \($namespace\)](dimmed green) '
disabled = false
contexts = [
  { context_pattern = "dev.local.cluster.k8s", style = "green", symbol = "💔 " },
]

Only show the module in directories that contain a k8s file.

# ~/.config/starship.toml

[kubernetes]
disabled = false
detect_files = ['k8s']

Kubernetes Context specific config

The contexts configuration option is used to customise what the current Kubernetes context name looks like (style and symbol) if the name matches the defined regular expression.

# ~/.config/starship.toml

[[kubernetes.contexts]]
# "bold red" style + default symbol when Kubernetes current context name equals "production" *and* the current user
# equals "admin_user"
context_pattern = "production"
user_pattern = "admin_user"
style = "bold red"
context_alias = "prod"
user_alias = "admin"

[[kubernetes.contexts]]
# "green" style + a different symbol when Kubernetes current context name contains openshift
context_pattern = ".*openshift.*"
style = "green"
symbol = "💔 "
context_alias = "openshift"

[[kubernetes.contexts]]
# Using capture groups
# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone.
# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`)
# and renames every matching kube context into a more readable format (`gke-cluster-name`):
context_pattern = "gke_.*_(?P<cluster>[\\w-]+)"
context_alias = "gke-$cluster"

Line Break

The line_break module separates the prompt into two lines.

Opsi

Opsi	Bawaan	Deskripsi
disabled	false	Disables the line_break module, making the prompt a single line.

Contoh

# ~/.config/starship.toml

[line_break]
disabled = true

Local IP

The localip module shows the IPv4 address of the primary network interface.

Opsi

Opsi	Bawaan	Deskripsi
ssh_only	true	Only show IP address when connected to an SSH session.
fromat	'[$localipv4]($style) '	Format dari modul.
style	'bold yellow'	Gaya penataan untuk modul.
disabled	true	Disables the localip module.

Variabel

Variabel	Contoh	Deskripsi
localipv4	192.168.1.13	Contains the primary IPv4 address
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[localip]
ssh_only = false
format = '@[$localipv4](bold red) '
disabled = false

Lua

The lua module shows the currently installed version of Lua. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• The current directory contains a .lua-version file
• The current directory contains a lua directory
• The current directory contains a file with the .lua extension

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'🌙 '	A format string representing the symbol of Lua.
detect_extensions	['lua']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['.lua-version']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	['lua']	Folder mana yang sebaiknya memicul modul ini.
style	'bold blue'	Gaya penataan untuk modul.
lua_binary	'lua'	Configures the lua binary that Starship executes when getting the version.
disabled	false	Disables the lua module.

Variabel

Variabel	Contoh	Deskripsi
version	v5.4.0	The version of lua
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[lua]
format = 'via [🌕 $version](bold blue) '

Memory Usage

The memory_usage module shows current system memory and swap usage.

By default the swap usage is displayed if the total system swap is non-zero.

::: tip

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Opsi

Opsi	Bawaan	Deskripsi
threshold	75	Hide the memory usage unless it exceeds this percentage.
fromat	'via $symbol [${ram}( | ${swap})]($style) '	Format dari modul.
symbol	'🐏'	The symbol used before displaying the memory usage.
style	'bold dimmed white'	Gaya penataan untuk modul.
disabled	true	Disables the memory_usage module.

Variabel

Variabel	Contoh	Deskripsi
ram	31GiB/65GiB	The usage/total RAM of the current system memory.
ram_pct	48%	The percentage of the current system memory.
swap**	1GiB/4GiB	The swap memory size of the current system swap memory file.
swap_pct**	77%	The swap memory percentage of the current system swap memory file.
symbol	🐏	Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: This variable can only be used as a part of a style string **: The SWAP file information is only displayed if detected on the current system

Contoh

# ~/.config/starship.toml

[memory_usage]
disabled = false
threshold = -1
symbol = ' '
style = 'bold dimmed green'

Meson

The meson module shows the current Meson developer environment status.

By default the Meson project name is displayed, if $MESON_DEVENV is set.

Opsi

Opsi	Bawaan	Deskripsi
truncation_length	2^32 - 1	Truncates a project name to N graphemes.
truncation_symbol	'…'	The symbol used to indicate a project name was truncated. You can use '' for no symbol.
fromat	'via [$symbol$project]($style) '	Format dari modul.
symbol	'⬢ '	The symbol used before displaying the project name.
style	'blue bold'	Gaya penataan untuk modul.
disabled	false	Disables the meson module.

Variabel

Variabel	Contoh	Deskripsi
project	starship	The current Meson project name
symbol	🐏	Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[meson]
disabled = false
truncation_symbol = '--'
symbol = ' '
style = 'bold dimmed green'

Mercurial Branch

The hg_branch module shows the active branch and topic of the repo in your current directory.

Opsi

Opsi	Bawaan	Deskripsi
symbol	' '	The symbol used before the hg bookmark or branch name of the repo in your current directory.
style	'bold purple'	Gaya penataan untuk modul.
fromat	'on [$symbol$branch(:$topic)]($style) '	Format dari modul.
truncation_length	2^63 - 1	Truncates the hg branch / topic name to N graphemes
truncation_symbol	'…'	The symbol used to indicate a branch name was truncated.
disabled	true	Disables the hg_branch module.

Variabel

Variabel	Contoh	Deskripsi
branch	master	The active mercurial branch
topic	feature	The active mercurial topic
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[hg_branch]
format = 'on [🌱 $branch](bold purple)'
truncation_length = 4
truncation_symbol = ''

Nim

The nim module shows the currently installed version of Nim. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• Direktori ini memiliki berkas nim.cfg
• The current directory contains a file with the .nim extension
• The current directory contains a file with the .nims extension
• The current directory contains a file with the .nimble extension

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	The format for the module
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'👑 '	The symbol used before displaying the version of Nim.
detect_extensions	['nim', 'nims', 'nimble']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['nim.cfg']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	'bold yellow'	Gaya penataan untuk modul.
disabled	false	Disables the nim module.

Variabel

Variabel	Contoh	Deskripsi
version	v1.2.0	The version of nimc
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[nim]
style = 'yellow'
symbol = '🎣 '

Nix-shell

The nix_shell module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol$state( \($name\))]($style) '	Format dari modul.
symbol	'❄️ '	A format string representing the symbol of nix-shell.
style	'bold blue'	Gaya penataan untuk modul.
impure_msg	'impure'	A format string shown when the shell is impure.
pure_msg	'pure'	A format string shown when the shell is pure.
unknown_msg	''	A format string shown when it is unknown if the shell is pure/impure.
disabled	false	Disables the nix_shell module.
heuristic	false	Attempts to detect new nix shell-style shells with a heuristic.

Variabel

Variabel	Contoh	Deskripsi
state	pure	The state of the nix-shell
name	lorri	The name of the nix-shell
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[nix_shell]
disabled = true
impure_msg = '[impure shell](bold red)'
pure_msg = '[pure shell](bold green)'
unknown_msg = '[unknown shell](bold yellow)'
format = 'via [☃️ $state( \($name\))](bold blue) '

Node.js

The nodejs module shows the currently installed version of Node.js. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• Direktori ini memiliki berkas package.json
• The current directory contains a .node-version file
• The current directory contains a .nvmrc file
• The current directory contains a node_modules directory
• The current directory contains a file with the .js, .mjs or .cjs extension
• The current directory contains a file with the .ts, .mts or .cts extension

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	' '	A format string representing the symbol of Node.js.
detect_extensions	['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['package.json', '.node-version']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	['node_modules']	Folder mana yang sebaiknya memicul modul ini.
style	'bold green'	Gaya penataan untuk modul.
disabled	false	Disables the nodejs module.
not_capable_style	bold red	The style for the module when an engines property in package.json does not match the Node.js version.

Variabel

Variabel	Contoh	Deskripsi
version	v13.12.0	The version of node
engines_version	>=12.0.0	node version requirement as set in the engines property of package.json. Will only show if the version requirement does not match the node version.
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[nodejs]
format = 'via [🤖 $version](bold green) '

OCaml

The ocaml module shows the currently installed version of OCaml. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• The current directory contains a file with .opam extension or _opam directory
• The current directory contains a esy.lock directory
• The current directory contains a dune or dune-project file
• The current directory contains a jbuild or jbuild-ignore file
• The current directory contains a .merlin file
• The current directory contains a file with .ml, .mli, .re or .rei extension

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)'	The format string for the module.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'🐫 '	The symbol used before displaying the version of OCaml.
global_switch_indicator	''	The format string used to represent global OPAM switch.
local_switch_indicator	'*'	The format string used to represent local OPAM switch.
detect_extensions	['opam', 'ml', 'mli', 're', 'rei']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	['_opam', 'esy.lock']	Folder mana yang sebaiknya memicul modul ini.
style	'bold yellow'	Gaya penataan untuk modul.
disabled	false	Disables the ocaml module.

Variabel

Variabel	Contoh	Deskripsi
version	v4.10.0	The version of ocaml
switch_name	my-project	The active OPAM switch
switch_indicator		Mirrors the value of indicator for currently active OPAM switch
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[ocaml]
format = 'via [🐪 $version]($style) '

Open Policy Agent

The opa module shows the currently installed version of the OPA tool. By default the module will be shown if the current directory contains a .rego file.

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'🪖 '	A format string representing the symbol of OPA.
detect_extensions	['rego']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	[]	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	'bold blue'	Gaya penataan untuk modul.
disabled	false	Disables the opa module.

Variabel

Variabel	Contoh	Deskripsi
version	v0.44.0	The version of opa
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[opa]
format = 'via [⛑️  $version](bold red) '

OpenStack

The openstack module shows the current OpenStack cloud and project. The module only active when the OS_CLOUD env var is set, in which case it will read clouds.yaml file from any of the default locations. to fetch the current project in use.

Opsi

Opsi	Bawaan	Deskripsi
fromat	'on [$symbol$cloud(\($project\))]($style) '	Format dari modul.
symbol	'☁️ '	The symbol used before displaying the current OpenStack cloud.
style	'bold yellow'	Gaya penataan untuk modul.
disabled	false	Disables the openstack module.

Variabel

Variabel	Contoh	Deskripsi
cloud	corp	The current OpenStack cloud
project	dev	The current OpenStack project
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[openstack]
format = 'on [$symbol$cloud(\($project\))]($style) '
style = 'bold yellow'
symbol = '☁️ '

OS

The os module shows the current operating system. OS information is detected via the os_info crate.

::: warning

The os_info crate used by this module is known to be inaccurate on some systems.

:::

::: tip

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Opsi

Opsi	Bawaan	Deskripsi
fromat	"[$symbol]($style)"	Format dari modul.
style	"bold white"	Gaya penataan untuk modul.
disabled	true	Disables the os module.
symbols		A table that maps each operating system to its symbol.

symbols allows you to define arbitrary symbols to display for each operating system type. Operating system types not defined by your configuration use the default symbols table below. All operating systems currently supported by the module are listed below. If you would like an operating system to be added, feel free to open a feature request.

# This is the default symbols table.
[os.symbols]
Alpaquita = "🔔 "
Alpine = "🏔️ "
Amazon = "🙂 "
Android = "🤖 "
Arch = "🎗️ "
Artix = "🎗️ "
CentOS = "💠 "
Debian = "🌀 "
DragonFly = "🐉 "
Emscripten = "🔗 "
EndeavourOS = "🚀 "
Fedora = "🎩 "
FreeBSD = "😈 "
Garuda = "🦅 "
Gentoo = "🗜️ "
HardenedBSD = "🛡️ "
Illumos = "🐦 "
Linux = "🐧 "
Mabox = "📦 "
Macos = "🍎 "
Manjaro = "🥭 "
Mariner = "🌊 "
MidnightBSD = "🌘 "
Mint = "🌿 "
NetBSD = "🚩 "
NixOS = "❄️ "
OpenBSD = "🐡 "
OpenCloudOS = "☁️ "
openEuler = "🦉 "
openSUSE = "🦎 "
OracleLinux = "🦴 "
Pop = "🍭 "
Raspbian = "🍓 "
Redhat = "🎩 "
RedHatEnterprise = "🎩 "
Redox = "🧪 "
Solus = "⛵ "
SUSE = "🦎 "
Ubuntu = "🎯 "
Unknown = "❓ "
Windows = "🪟 "

Variabel

Variabel	Contoh	Deskripsi
symbol	🎗️	The current operating system symbol from advanced option symbols
name	Arch Linux	The current operating system name
type	Arch	The current operating system type
codename		The current operating system codename, if applicable
edition		The current operating system edition, if applicable
version		The current operating system version, if applicable
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[os]
format = "on [($name )]($style)"
style = "bold blue"
disabled = false

[os.symbols]
Windows = " "
Arch = "Arch is the best! "

Package Version

The package module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports npm, nimble, cargo, poetry, python, composer, gradle, julia, mix, helm, shards, daml and dart packages.

• npm – The npm package version is extracted from the package.json present in the current directory
• Cargo – The cargo package version is extracted from the Cargo.toml present in the current directory
• Nimble - The nimble package version is extracted from the *.nimble file present in the current directory with the nimble dump command
• Poetry – The poetry package version is extracted from the pyproject.toml present in the current directory
• Python - The python package version is extracted from a PEP 621 compliant pyproject.toml or a setup.cfg present in the current directory
• Composer – The composer package version is extracted from the composer.json present in the current directory
• Gradle – The gradle package version is extracted from the build.gradle present in the current directory
• Julia - The package version is extracted from the Project.toml present in the current directory
• Mix - The mix package version is extracted from the mix.exs present in the current directory
• Helm - The helm chart version is extracted from the Chart.yaml present in the current directory
• Maven - The maven package version is extracted from the pom.xml present in the current directory
• Meson - The meson package version is extracted from the meson.build present in the current directory
• Shards - The shards package version is extracted from the shard.yml present in the current directory
• V - The vlang package version is extracted from the v.mod present in the current directory
• SBT - The sbt package version is extracted from the build.sbt present in the current directory
• Daml - The daml package version is extracted from the daml.yaml present in the current directory
• Dart - The dart package version is extracted from the pubspec.yaml present in the current directory

⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.

Opsi

Opsi	Bawaan	Deskripsi
fromat	'is [$symbol$version]($style) '	Format dari modul.
symbol	'📦 '	The symbol used before displaying the version the package.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
style	'bold 208'	Gaya penataan untuk modul.
display_private	false	Enable displaying version for packages marked as private.
disabled	false	Disables the package module.

Variabel

Variabel	Contoh	Deskripsi
version	v1.0.0	The version of your package
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[package]
format = 'via [🎁 $version](208 bold) '

Perl

The perl module shows the currently installed version of Perl. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• The current directory contains a Makefile.PL or Build.PL file
• The current directory contains a cpanfile or cpanfile.snapshot file
• The current directory contains a META.json file or META.yml file
• The current directory contains a .perl-version file
• The current directory contains a .pl, .pm or .pod

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	The format string for the module.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'🐪 '	The symbol used before displaying the version of Perl
detect_extensions	['pl', 'pm', 'pod']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	'bold 149'	Gaya penataan untuk modul.
disabled	false	Disables the perl module.

Variabel

Variabel	Contoh	Deskripsi
version	v5.26.1	The version of perl
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

Contoh

# ~/.config/starship.toml

[perl]
format = 'via [🦪 $version]($style) '

PHP

The php module shows the currently installed version of PHP. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• Direktori ini memiliki berkas composer.json
• The current directory contains a .php-version file
• The current directory contains a .php extension

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'🐘 '	The symbol used before displaying the version of PHP.
detect_extensions	['php']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['composer.json', '.php-version']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	'147 bold'	Gaya penataan untuk modul.
disabled	false	Disables the php module.

Variabel

Variabel	Contoh	Deskripsi
version	v7.3.8	The version of php
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[php]
format = 'via [🔹 $version](147 bold) '

Pijul Channel

The pijul_channel module shows the active channel of the repo in your current directory.

Opsi

Opsi	Bawaan	Deskripsi
symbol	' '	The symbol used before the pijul channel name of the repo in your current directory.
style	'bold purple'	Gaya penataan untuk modul.
fromat	'on [$symbol$channel]($style) '	Format dari modul.
truncation_length	2^63 - 1	Truncates the pijul channel name to N graphemes
truncation_symbol	'…'	The symbol used to indicate a branch name was truncated.
disabled	true	Disables the pijul module.

Pulumi

The pulumi module shows the current username, selected Pulumi Stack, and version.

::: tip

By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, follow the example shown below.

:::

Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• The current directory contains either Pulumi.yaml or Pulumi.yml
• A parent directory contains either Pulumi.yaml or Pulumi.yml unless search_upwards is set to false

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($username@)$stack]($style) '	The format string for the module.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	' '	A format string shown before the Pulumi stack.
style	'bold 5'	Gaya penataan untuk modul.
search_upwards	true	Enable discovery of pulumi config files in parent directories.
disabled	false	Disables the pulumi module.

Variabel

Variabel	Contoh	Deskripsi
version	v0.12.24	The version of pulumi
stack	dev	The current Pulumi stack
username	alice	The current Pulumi username
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

With Pulumi Version

# ~/.config/starship.toml

[pulumi]
format = '[🛥 ($version )$stack]($style) '

Without Pulumi version

# ~/.config/starship.toml
[pulumi]
symbol = '🛥 '
format = '[$symbol$stack]($style) '

PureScript

The purescript module shows the currently installed version of PureScript version. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• Direktori ini memiliki berkas spago.dhall
• The current directory contains a file with the .purs extension

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'<=> '	The symbol used before displaying the version of PureScript.
detect_extensions	['purs']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['spago.dhall']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	'bold white'	Gaya penataan untuk modul.
disabled	false	Disables the purescript module.

Variabel

Variabel	Contoh	Deskripsi
version	0.13.5	The version of purescript
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[purescript]
format = 'via [$symbol$version](bold white)'

Python

The python module shows the currently installed version of Python and the current Python virtual environment if one is activated.

If pyenv_version_name is set to true, it will display the pyenv version name. Otherwise, it will display the version number from python --version.

Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• The current directory contains a .python-version file
• The current directory contains a Pipfile file
• The current directory contains a __init__.py file
• Direktori ini memiliki berkas pyproject.toml
• Direktori ini memiliki berkas requirements.txt
• Direktori ini memiliki berkas setup.py
• Direktori ini memiliki berkas tox.ini
• The current directory contains a file with the .py extension.
• A virtual environment is currently activated

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'🐍 '	A format string representing the symbol of Python
style	'yellow bold'	Gaya penataan untuk modul.
pyenv_version_name	false	Use pyenv to get Python version
pyenv_prefix	pyenv	Prefix before pyenv version display, only used if pyenv is used
python_binary	['python', 'python3', 'python2']	Configures the python binaries that Starship should executes when getting the version.
detect_extensions	['py']	Ekstensi mana yang sebaiknya memicu modul ini
detect_files	['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']	filenames mana yang sebaiknya memicu modul ini
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini
disabled	false	Disables the python module.

::: tip

The python_binary variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.

The default values and order for python_binary was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a python, no matter if it points to python3 or python2). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink /usr/bin/python to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to 'python3' will hide any Python version 2, see example below.

:::

Variabel

Variabel	Contoh	Deskripsi
version	'v3.8.1'	The version of python
symbol	'🐍 '	Menyalin nilai dari opsi symbol
style	'yellow bold'	Menyalin nilai dari opsi style
pyenv_prefix	'pyenv '	Mirrors the value of option pyenv_prefix
virtualenv	'venv'	The current virtualenv name

Contoh

# ~/.config/starship.toml

[python]
symbol = '👾 '
pyenv_version_name = true

# ~/.config/starship.toml

[python]
# Only use the `python3` binary to get the version.
python_binary = 'python3'

# ~/.config/starship.toml

[python]
# Don't trigger for files with the py extension
detect_extensions = []

# ~/.config/starship.toml

[python]
# Display the version of python from inside a local venv.
#
# Note this will only work when the venv is inside the project and it will only
# work in the directory that contains the venv dir but maybe this is ok?
python_binary = ['./venv/bin/python', 'python', 'python3', 'python2']

R

The rlang module shows the currently installed version of R. The module will be shown if any of the following conditions are met:

• The current directory contains a file with the .R extension.
• The current directory contains a file with the .Rd extension.
• The current directory contains a file with the .Rmd extension.
• The current directory contains a file with the .Rproj extension.
• The current directory contains a file with the .Rsx extension.
• The current directory contains a .Rprofile file
• The current directory contains a .Rproj.user folder

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'📐'	A format string representing the symbol of R.
style	'blue bold'	Gaya penataan untuk modul.
detect_extensions	['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']	Ekstensi mana yang sebaiknya memicu modul ini
detect_files	['.Rprofile']	filenames mana yang sebaiknya memicu modul ini
detect_folders	['.Rproj.user']	Folder mana yang sebaiknya memicul modul ini
disabled	false	Disables the r module.

Variabel

Variabel	Contoh	Deskripsi
version	v4.0.5	The version of R
symbol		Menyalin nilai dari opsi symbol
style	'blue bold'	Menyalin nilai dari opsi style

Contoh

# ~/.config/starship.toml

[rlang]
format = 'with [📐 $version](blue bold) '

Raku

The raku module shows the currently installed version of Raku. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• The current directory contains a META6.json file
• The current directory contains a .p6, .pm6, .raku, .rakumod or .pod6

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version-$vm_version )]($style)'	The format string for the module.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'🦋 '	The symbol used before displaying the version of Raku
detect_extensions	['p6', 'pm6', 'pod6', 'raku', 'rakumod']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['META6.json']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	'bold 149'	Gaya penataan untuk modul.
disabled	false	Disables the raku module.

Variabel

Variabel	Contoh	Deskripsi
version	v6.d	The version of raku
vm_version	moar	The version of VM raku is built on
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

Contoh

# ~/.config/starship.toml

[raku]
format = 'via [🦪 $version]($style) '

Red

By default the red module shows the currently installed version of Red. The module will be shown if any of the following conditions are met:

• The current directory contains a file with .red or .reds extension

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'🔺 '	A format string representing the symbol of Red.
detect_extensions	['red']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	[]	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	'red bold'	Gaya penataan untuk modul.
disabled	false	Disables the red module.

Variabel

Variabel	Contoh	Deskripsi
version	v2.5.1	The version of red
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[red]
symbol = '🔴 '

Ruby

By default the ruby module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:

• The current directory contains a Gemfile file
• The current directory contains a .ruby-version file
• The current directory contains a .rb file
• The environment variables RUBY_VERSION or RBENV_VERSION are set

Starship gets the current Ruby version by running ruby -v.

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'💎 '	A format string representing the symbol of Ruby.
detect_extensions	['rb']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['Gemfile', '.ruby-version']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
detect_variables	['RUBY_VERSION', 'RBENV_VERSION']	Which environment variables should trigger this module.
style	'bold red'	Gaya penataan untuk modul.
disabled	false	Disables the ruby module.

Variabel

Variabel	Contoh	Deskripsi
version	v2.5.1	The version of ruby
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[ruby]
symbol = '🔺 '

Rust

By default the rust module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:

• The current directory contains a Cargo.toml file
• The current directory contains a file with the .rs extension

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'🦀 '	A format string representing the symbol of Rust
detect_extensions	['rs']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['Cargo.toml']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	'bold red'	Gaya penataan untuk modul.
disabled	false	Disables the rust module.

Variabel

Variabel	Contoh	Deskripsi
version	v1.43.0-nightly	The version of rustc
numver	1.51.0	The numeric component of the rustc version
toolchain	beta	The toolchain version
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[rust]
format = 'via [⚙️ $version](red bold)'

Scala

The scala module shows the currently installed version of Scala. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• The current directory contains a build.sbt, .scalaenv or .sbtenv file
• The current directory contains a file with the .scala or .sbt extension
• The current directory contains a directory named .metals

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [${symbol}(${version} )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
detect_extensions	['sbt', 'scala']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['.scalaenv', '.sbtenv', 'build.sbt']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	['.metals']	Folder mana yang sebaiknya memicul modul ini.
symbol	'🆂 '	A format string representing the symbol of Scala.
style	'red dimmed'	Gaya penataan untuk modul.
disabled	false	Disables the scala module.

Variabel

Variabel	Contoh	Deskripsi
version	2.13.5	The version of scala
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[scala]
symbol = '🌟 '

Shell

The shell module shows an indicator for currently used shell.

::: tip

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Opsi

Opsi	Bawaan	Deskripsi
bash_indicator	'bsh'	A format string used to represent bash.
fish_indicator	'fsh'	A format string used to represent fish.
zsh_indicator	'zsh'	A format string used to represent zsh.
powershell_indicator	'psh'	A format string used to represent powershell.
ion_indicator	'ion'	A format string used to represent ion.
elvish_indicator	'esh'	A format string used to represent elvish.
tcsh_indicator	'tsh'	A format string used to represent tcsh.
xonsh_indicator	'xsh'	A format string used to represent xonsh.
cmd_indicator	'cmd'	A format string used to represent cmd.
nu_indicator	'nu'	A format string used to represent nu.
unknown_indicator	''	The default value to be displayed when the shell is unknown.
fromat	'[$indicator]($style) '	Format dari modul.
style	'white bold'	Gaya penataan untuk modul.
disabled	true	Disables the shell module.

Variabel

Variabel	Bawaan	Deskripsi
indicator		Mirrors the value of indicator for currently used shell.
style*		Mirrors the value of option style.

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[shell]
fish_indicator = '󰈺 '
powershell_indicator = '_'
unknown_indicator = 'mystery shell'
style = 'cyan bold'
disabled = false

SHLVL

The shlvl module shows the current SHLVL ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold.

Opsi

Opsi	Bawaan	Deskripsi
threshold	2	Display threshold.
fromat	'[$symbol$shlvl]($style) '	Format dari modul.
symbol	'↕️ '	The symbol used to represent the SHLVL.
repeat	false	Causes symbol to be repeated by the current SHLVL amount.
repeat_offset	0	Decrements number of times symbol is repeated by the offset value
style	'bold yellow'	Gaya penataan untuk modul.
disabled	true	Disables the shlvl module.

Variabel

Variabel	Contoh	Deskripsi
shlvl	3	The current value of SHLVL
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[shlvl]
disabled = false
format = '$shlvl level(s) down'
threshold = 3

Using repeat and repeat_offset along with character module, one can get prompt like ❯❯❯ where last character is colored appropriately for return status code and preceeding characters are provided by shlvl.

# ~/.config/starship.toml

[shlvl]
disabled = false
format = '[$symbol$shlvl]($style)'
repeat = true
symbol = '❯'
repeat_offset = 1
threshold = 0

Singularity

The singularity module shows the current Singularity image, if inside a container and $SINGULARITY_NAME is set.

Opsi

Opsi	Bawaan	Deskripsi
fromat	'[$symbol\[$env\]]($style) '	Format dari modul.
symbol	''	A format string displayed before the image name.
style	'bold dimmed blue'	Gaya penataan untuk modul.
disabled	false	Disables the singularity module.

Variabel

Variabel	Contoh	Deskripsi
env	centos.img	The current Singularity image
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[singularity]
format = '[📦 \[$env\]]($style) '

Solidity

The solidity module shows the currently installed version of Solidity The module will be shown if any of the following conditions are met:

• The current directory contains a file with the .sol extension

Opsi

Opsi	Bawaan	Deskripsi
fromat	"via [$symbol($version )]($style)"	Format dari modul.
version_format	"v${major}.${minor}.${patch}"	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	"S "	A format string representing the symbol of Solidity
`compiler	["solc"]	The default compiler for Solidity.
detect_extensions	["sol"]	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	[]	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	"bold blue"	Gaya penataan untuk modul.
disabled	false	Disables this module.

Variabel

Variabel	Contoh	Deskripsi
version	v0.8.1	The version of solidity
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml
[solidity]
format = "via [S $version](blue bold)"

Spack

The spack module shows the current Spack environment, if $SPACK_ENV is set.

Opsi

Opsi	Bawaan	Deskripsi
truncation_length	1	The number of directories the environment path should be truncated to. 0 artinya tidak ada potongan. Lihat juga modul directory.
symbol	'🅢 '	Simbol yang digunakan sebelum nama environment.
style	'bold blue'	Gaya penataan untuk modul.
fromat	'via [$symbol$environment]($style) '	Format dari modul.
disabled	false	Disables the spack module.

Variabel

Variabel	Contoh	Deskripsi
environment	astronauts	The current spack environment
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[spack]
format = '[$symbol$environment](dimmed blue) '

Status

The status module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not 0. The status code will cast to a signed 32-bit integer.

::: tip

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Opsi

Opsi	Bawaan	Deskripsi
fromat	'[$symbol$status]($style) '	The format of the module
symbol	'❌'	The symbol displayed on program error
success_symbol	''	The symbol displayed on program success
not_executable_symbol	'🚫'	The symbol displayed when file isn't executable
not_found_symbol	'🔍'	The symbol displayed when the command can't be found
sigint_symbol	'🧱'	The symbol displayed on SIGINT (Ctrl + c)
signal_symbol	'⚡'	The symbol displayed on any signal
style	'bold red'	Gaya penataan untuk modul.
recognize_signal_code	true	Enable signal mapping from exit code
map_symbol	false	Enable symbols mapping from exit code
pipestatus	false	Enable pipestatus reporting
pipestatus_separator	|	The symbol used to separate pipestatus segments (supports formatting)
pipestatus_format	'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style)'	The format of the module when the command is a pipeline
pipestatus_segment_format		When specified, replaces format when formatting pipestatus segments
disabled	true	Disables the status module.

Variabel

Variabel	Contoh	Deskripsi
status	127	The exit code of the last command
hex_status	0x7F	The exit code of the last command in hex
int	127	The exit code of the last command
common_meaning	ERROR	Meaning of the code if not a signal
signal_number	9	Signal number corresponding to the exit code, only if signalled
signal_name	KILL	Name of the signal corresponding to the exit code, only if signalled
maybe_int	7	Contains the exit code number when no meaning has been found
pipestatus		Rendering of in pipeline programs' exit codes, this is only available in pipestatus_format
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[status]
style = 'bg:blue'
symbol = '🔴 '
success_symbol = '🟢 SUCCESS'
format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) '
map_symbol = true
disabled = false

Sudo

The sudo module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.

::: tip

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Opsi

Opsi	Bawaan	Deskripsi
fromat	'[as $symbol]($style)'	The format of the module
symbol	'🧙 '	The symbol displayed when credentials are cached
style	'bold blue'	Gaya penataan untuk modul.
allow_windows	false	Since windows has no default sudo, default is disabled.
disabled	true	Disables the sudo module.

Variabel

Variabel	Contoh	Deskripsi
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[sudo]
style = 'bold green'
symbol = '👩‍💻 '
disabled = false

# On windows
# $HOME\.starship\config.toml

[sudo]
allow_windows = true
disabled = false

Swift

By default the swift module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:

• The current directory contains a Package.swift file
• The current directory contains a file with the .swift extension

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'🐦 '	A format string representing the symbol of Swift
detect_extensions	['swift']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['Package.swift']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	'bold 202'	Gaya penataan untuk modul.
disabled	false	Disables the swift module.

Variabel

Variabel	Contoh	Deskripsi
version	v5.2.4	The version of swift
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[swift]
format = 'via [🏎  $version](red bold)'

Terraform

The terraform module shows the currently selected Terraform workspace and version.

::: tip

By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, follow the example shown below.

:::

Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• The current directory contains a .terraform folder
• Current directory contains a file with the .tf, .tfplan or .tfstate extensions

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol$workspace]($style) '	The format string for the module.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'💠'	A format string shown before the terraform workspace.
detect_extensions	['tf', 'tfplan', 'tfstate']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	[]	filenames mana yang sebaiknya memicu modul ini.
detect_folders	['.terraform']	Folder mana yang sebaiknya memicul modul ini.
style	'bold 105'	Gaya penataan untuk modul.
disabled	false	Disables the terraform module.

Variabel

Variabel	Contoh	Deskripsi
version	v0.12.24	The version of terraform
workspace	bawaan	The current Terraform workspace
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

With Terraform Version

# ~/.config/starship.toml

[terraform]
format = '[🏎💨 $version$workspace]($style) '

Without Terraform version

# ~/.config/starship.toml

[terraform]
format = '[🏎💨 $workspace]($style) '

Waktu

The time module shows the current local time. The format configuration value is used by the chrono crate to control how the time is displayed. Take a look at the chrono strftime docs to see what options are available.

::: tip

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Opsi

Opsi	Bawaan	Deskripsi
fromat	'at [$time]($style) '	The format string for the module.
use_12hr	false	Enables 12 hour formatting
time_format	see below	The chrono format string used to format the time.
style	'bold yellow'	The style for the module time
utc_time_offset	'local'	Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets.
disabled	true	Disables the time module.
time_range	'-'	Sets the time range during which the module will be shown. Times must be specified in 24-hours format

If use_12hr is true, then time_format defaults to '%r'. Otherwise, it defaults to '%T'. Manually setting time_format will override the use_12hr setting.

Variabel

Variabel	Contoh	Deskripsi
time	13:08:10	The current time.
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[time]
disabled = false
format = '🕙[\[ $time \]]($style) '
time_format = '%T'
utc_time_offset = '-5'
time_range = '10:00:00-14:00:00'

Username

The username module shows active user's username. The module will be shown if any of the following conditions are met:

• The current user is root/admin
• The current user isn't the same as the one that is logged in
• The user is currently connected as an SSH session
• The variable show_always is set to true

::: tip

SSH connection is detected by checking environment variables SSH_CONNECTION, SSH_CLIENT, and SSH_TTY. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value.

:::

Opsi

Opsi	Bawaan	Deskripsi
style_root	'bold red'	The style used when the user is root/admin.
style_user	'bold yellow'	The style used for non-root users.
fromat	'[$user]($style) in '	Format dari modul.
show_always	false	Always shows the username module.
disabled	false	Disables the username module.

Variabel

Variabel	Contoh	Deskripsi
style	'red bold'	Mirrors the value of option style_root when root is logged in and style_user otherwise.
user	'matchai'	The currently logged-in user ID.

Contoh

# ~/.config/starship.toml

[username]
style_user = 'white bold'
style_root = 'black bold'
format = 'user: [$user]($style) '
disabled = false
show_always = true

Vagrant

The vagrant module shows the currently installed version of Vagrant. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• The current directory contains a Vagrantfile file

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'⍱ '	A format string representing the symbol of Vagrant.
detect_extensions	[]	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['Vagrantfile']	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	'cyan bold'	Gaya penataan untuk modul.
disabled	false	Disables the vagrant module.

Variabel

Variabel	Contoh	Deskripsi
version	Vagrant 2.2.10	The version of Vagrant
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[vagrant]
format = 'via [⍱ $version](bold white) '

V

The vlang module shows you your currently installed version of V. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:

• The current directory contains a file with .v extension
• The current directory contains a v.mod, vpkg.json or .vpkg-lock.json file

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'V '	A format string representing the symbol of V
detect_extensions	['v']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	['v.mod', 'vpkg.json', '.vpkg-lock.json' ]	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.
style	'blue bold'	Gaya penataan untuk modul.
disabled	false	Disables the vlang module.

Variabel

Variabel	Contoh	Deskripsi
version	v0.2	The version of v
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

Contoh

# ~/.config/starship.toml
[vlang]
format = 'via [V $version](blue bold) '

VCSH

The vcsh module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.

Opsi

Opsi	Bawaan	Deskripsi
symbol	''	The symbol used before displaying the repository name.
style	'bold yellow'	Gaya penataan untuk modul.
fromat	'vcsh [$symbol$repo]($style) '	Format dari modul.
disabled	false	Disables the vcsh module.

Variabel

Variabel	Contoh	Deskripsi
repo	dotfiles if in a VCSH repo named dotfiles	The active repository name
symbol		Menyalin nilai dari opsi symbol
style*	black bold dimmed	Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[vcsh]
format = '[🆅 $repo](bold blue) '

Zig

By default the zig module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:

• The current directory contains a .zig file

Opsi

Opsi	Bawaan	Deskripsi
fromat	'via [$symbol($version )]($style)'	Format dari modul.
version_format	'v${raw}'	Format dari versi. Variabel yang tersedia adalah raw, major, minor, & patch
symbol	'↯ '	The symbol used before displaying the version of Zig.
style	'bold yellow'	Gaya penataan untuk modul.
disabled	false	Disables the zig module.
detect_extensions	['zig']	Ekstensi mana yang sebaiknya memicu modul ini.
detect_files	[]	filenames mana yang sebaiknya memicu modul ini.
detect_folders	[]	Folder mana yang sebaiknya memicul modul ini.

Variabel

Variabel	Contoh	Deskripsi
version	v0.6.0	The version of zig
symbol		Menyalin nilai dari opsi symbol
style*		Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Contoh

# ~/.config/starship.toml

[zig]
symbol = '⚡️ '

Custom commands

The custom modules show the output of some arbitrary commands.

These modules will be shown if any of the following conditions are met:

• The current directory contains a file whose name is in detect_files
• The current directory contains a directory whose name is in detect_folders
• The current directory contains a file whose extension is in detect_extensions
• The when command returns 0
• The current Operating System (std::env::consts::OS) matches with os field if defined.

::: tip

Multiple custom modules can be defined by using a ..

:::

::: tip

The order in which custom modules are shown can be individually set by including ${custom.foo} in the top level format (as it includes a dot, you need to use ${...}). By default, the custom module will simply show all custom modules in the order they were defined.

:::

::: tip

Issue #1252 contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there!

:::

::: warning Command output is printed unescaped to the prompt

Whatever output the command generates is printed unmodified in the prompt. This means if the output contains special sequences that are interpreted by your shell they will be expanded when displayed. These special sequences are shell specific, e.g. you can write a command module that writes bash sequences, e.g. \h, but this module will not work in a fish or zsh shell.

Format strings can also contain shell specific prompt sequences, e.g. Bash, Zsh.

:::

Opsi

Opsi	Bawaan	Deskripsi
command	''	The command whose output should be printed. The command will be passed on stdin to the shell.
when	false	Either a boolean value (true or false, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a 0 status code.
require_repo	false	If true, the module will only be shown in paths containing a (git) repository. This option alone is not sufficient display condition in absence of other options.
shell		See below
description	'<custom module>'	The description of the module that is shown when running starship explain.
detect_files	[]	The files that will be searched in the working directory for a match.
detect_folders	[]	The directories that will be searched in the working directory for a match.
detect_extensions	[]	The extensions that will be searched in the working directory for a match.
symbol	''	The symbol used before displaying the command output.
style	'bold green'	Gaya penataan untuk modul.
fromat	'[$symbol($output )]($style)'	Format dari modul.
disabled	false	Disables this custom module.
os		Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) See possible values.
use_stdin		An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling.
ignore_timeout	false	Ignore global command_timeout setting and keep running external commands, no matter how long they take.

Variabel

Variabel	Deskripsi
output	The output of shell command in shell
symbol	Menyalin nilai dari opsi symbol
style*	Menyalin nilai dari opsi style

*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

Custom command shell

shell accepts a non-empty list of strings, where:

• The first string is the path to the shell to use to execute the command.
• Other following arguments are passed to the shell.

If unset, it will fallback to STARSHIP_SHELL and then to 'sh' on Linux, and 'cmd /C' on Windows.

The command will be passed in on stdin.

If shell is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: -NoProfile -Command -. If shell is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: /C and stdin will be set to false. If shell is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: -c and stdin will be set to false. This behavior can be avoided by explicitly passing arguments to the shell, e.g.

shell = ['pwsh', '-Command', '-']

::: warning Make sure your custom shell configuration exits gracefully

If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the shell option).

For example, PowerShell requires the -Command parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.

Parameters similar to -NoProfile in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.

Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. Please open an issue with shell details and starship configuration if you hit such scenario.

:::

Contoh

# ~/.config/starship.toml

[custom.foo]
command = 'echo foo' # shows output of command
detect_files = ['foo'] # can specify filters but wildcards are not supported
when = ''' test "$HOME" = "$PWD" '''
format = ' transcending [$output]($style)'

[custom.time]
command = 'time /T'
detect_extensions = ['pst'] # filters *.pst files
shell = ['pwsh.exe', '-NoProfile', '-Command', '-']

[custom.time-as-arg]
command = 'time /T'
detect_extensions = ['pst'] # filters *.pst files
shell = ['pwsh.exe', '-NoProfile', '-Command']
use_stdin = false