diff --git a/docs/docs/cli-reference/package-init.md b/docs/docs/cli-reference/package-init.md index cd19daa9c8..ec18f91365 100644 --- a/docs/docs/cli-reference/package-init.md +++ b/docs/docs/cli-reference/package-init.md @@ -1,14 +1,19 @@ -# kurtosis package init -This command initializes the current directory to be a [Kurtosis package][package] by creating a [`kurtosis.yml` file][kurtosis-yml] with the given package name. +--- +title: package init +sidebar_label: package init +slug: /package-init +--- + +The `package init` command converts the current directory into a [Kurtosis package][package] by generating a new [`kurtosis.yml`][kurtosis-yml] file and a `main.star` file using the given package name, if they do not already exist. ``` -Usage: - kurtosis package init [flags] package_name +kurtosis package init $PACKAGE_NAME ``` -The `package_name` argument is the [locator][locators]to the package, in the format `github.com/USER/REPO`. +The optional `$PACKAGE_NAME` argument is the [locator][locators] to the package, in the format `github.com/USER/REPO`. If an argument is not passed, the package locator will simply be: `github.com/example-org/example-package` by default. + [package]: ../concepts-reference/packages.md [kurtosis-yml]: ../concepts-reference/kurtosis-yml.md [locators]: ../concepts-reference/locators.md -[executable-package]: ../concepts-reference/packages.md#runnable-packages \ No newline at end of file +[executable-package]: ../concepts-reference/packages.md#runnable-packages