Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Set up init

kater init local-copy

Makes a local copy of everything you can read in Kater.

This is step 7 of kater init. A local copy is the folder where you, your editor and your agent work on Kater content.

Examples

Terminal window
# Make a local copy in the current folder, which must be empty
kater init local-copy
# Make a local copy in the kater-content folder
kater init local-copy kater-content

Arguments

ArgumentDescription
<folder>Optional. Where to make the local copy. Leave it out to use the current folder, which must be empty.

Options

It also takes --help.

How it makes the copy

  • It makes the copy as kater git clone does.
  • When the folder is already in a local copy, it uses that copy and makes no other.
  • When the current folder is not empty, the command stops with the code folder_needed. Give a folder.
  • The answer gives the folder, and made says whether the command made a new copy.

It needs the settings:manage permission.

See also