Configuration

The workspace configuration is stored in ./workspace.edn and defines the following keys:
Key
Description
:vcs
A map with two keys, where name is set to "git" which is the only supported version control system at the moment. The key auto-add is a boolean flag that tells whether directories and files added by the create command should automatically be added to git or not.
:top-namespace
The workspace top namespace. If changed, the source code has to be changed accordingly.
:interface-ns
The default value is interface. If changed, the source code has to be changed accordingly.
:default‑profile‑name
The default value is default. If changed, the +default alias in ./deps.edn has to be renamed accordingly.
:compact-views
The default value is #{}. If set to #{"libs"}, then the libs diagram will be shown in a more compact format. The deps view is also supported, e.g. #{"libs" "deps"}.
:tag-patterns
The default value for the 'release' key is v[0-9]*, and for the 'stable' key it's stable-*. If changed, old tags may not be recognised.
:projects
If the development key is missing, {"development" {:alias "dev"} will be added.
Only the :top-namespace attribute is mandatory, all other attributes will use their default values.
Settings that are unique per developer/user are stored in ~/.polylith/config.edn:
Key
Description
:thousand‑sep
Set to "," by default (when first created).
:color-mode
Set to "none" on Windows, "dark" on other operating systems (when first created). Valid values are "none", "light" and "dark", see the color section. Can be overridden, e.g.: poly info color-mode:none.
:empty-character
Set to "." by default (when first created). Used by the deps and libs commands.
:m2-dir
If omitted, the .m2 directory will be set to USER-HOME/.m2. Used by the libs command to calculate file sizes (KB).
If ~/.polylith/config.edn doesn't exists, it will be created the first time the create workspace command is executed, e.g.:
1
{:color-mode "dark"
2
 :thousand-separator ","
3
 :empty-character "."}
Copied!
​

Workflow - Previous

Libraries

Next - Workflow

Explore the workspace

Last modified 2mo ago

Copy link