ESC[33m
Liking cljdoc? Tell your friends :D
Colors
The poly tool uses color to make its output easier to digest.
The Dark column shows the colors used in all the examples, while Light is the colors used by polyx when color-mode is set to light.
| Name | ANSI Color | Dark | Light | Example poly Usages |
|---|---|---|---|---|
yellow |
|
| interfaces, warning messages | |
green |
|
|
| components, success messages |
blue |
|
|
| bases |
purple |
|
|
| projects |
red |
|
|
| error messages |
light grey |
|
|
| tags and shas (dark mode) |
dark grey |
| - | - | tags and shas (light mode) |
white (background) |
| - |
| Used as background color by polyx when |
black (background) |
|
| - | Used as background color by polyx when |
Your OS terminal shell and its color theme configuration can redefine these colors. If you want to match our dark scheme preference (inspired by the Cursive Borealis color scheme), configure your terminal to use the sample colors from the table above.
Config
When you create your first workspace, poly creates a user config file that specifies a color-mode:
~/.config/polylith/config.edn
{:color-mode "dark" (1)
:thousand-separator ","
:empty-character "·"}| 1 | The poly tool sets the initial value to "dark" on macOS and Linux and to "none" on Windows. |
Valid color-mode values are "none", "light", and "dark".
We don’t support colored text on Windows, so poly sets the initial :color-mode on Windows to "none".
|
If you use a light theme for your OS terminal shell, consider switching :color-mode to "light".
The only difference between "light" and "dark" is very subtle; they use different shades of grey.
The shade of grey in the "light" mode can show up better when using a light theme in your OS terminal shell.
Usage
Throughout our documentation, our screenshots show output from an OS terminal shell configured with a dark theme with :color-mode left at its default "dark":
poly info
When you can specify color-mode as an argument, it will override your poly config.
Assuming you’ve configured your OS terminal shell to a light color scheme, you might want to tell poly to use color-mode:light:
poly info color-mode:light
When you specify a color-mode of none:
poly info color-mode:noneThe poly tool will emit uncolored plaintext:
stable since: 65957ce | stable-lisa
projects: 3 interfaces: 1
bases: 2 components: 2
active profiles: default
project alias status dev remote
------------------------------ -----------
command-line * cl -t- -t- --
user-service * user-s --- --- --
development * dev s-- s-- --
interface brick cl user-s dev remote
------------------------ ----------- -----------
user user * --- stx st- --
user user-remote * stx --- --- st
- cli * stx --- st- --
- user-api * --- stx st- --Can you improve this documentation? These fine people already did:
Joakim Tengstrand & Lee ReadEdit on GitHub
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close