diff --git a/docs/cli/init.md b/docs/cli/init.md index 7199b6efb..60cdacd97 100644 --- a/docs/cli/init.md +++ b/docs/cli/init.md @@ -25,13 +25,15 @@ initialize a [source-git repo](/source-git). Usage: packit init [OPTIONS] [PATH_OR_URL] - Create the initial Packit configuration in a repository + Create the initial Packit configuration in a repository and add a pre-commit + hook to validate Packit configuration file See 'packit source-git init', if you want to initialize a repository as a source-git repo. Options: - --force-precommit Automatically create an empty pre-commit configuration file if missing. - --without-precommit Skip adding pre-commit hook to pre-commit configuration file. -f, --force Reset config to default if already exists. + --without_precommit Skip adding packit-specific pre-commit configuration + hook. + --force_precommit Create pre-commit configuration file if missing. -h, --help Show this message and exit. diff --git a/docs/cli/test.md b/docs/cli/test.md index ca39878e5..ac2b1dca3 100644 --- a/docs/cli/test.md +++ b/docs/cli/test.md @@ -83,26 +83,21 @@ The command supports two main workflows: ## Help - Usage: packit test [OPTIONS] + Usage: packit test [OPTIONS] [PATH_OR_URL] - Run tmt tests locally using content from the upstream repository. - - This command builds RPMs from the current repository state and runs - tests in containerized environments, mimicking Packit's testing service - behavior for local debugging and development. + Run tmt tests locally without needing a PR or release Options: - --rpm-paths PATH Path to RPM file(s) to test. Can be used - multiple times. If not provided, RPMs will - be built automatically from source. - --target TEXT Container image for testing environment - (e.g., 'fedora:39', 'centos:stream9'). - Defaults to 'fedora:rawhide'. - --plans TEXT tmt plan name(s) to execute. Can be used - multiple times to run specific plans only. - If not specified, all plans are executed. - --clean-before / --no-clean-before - Run 'tmt clean --all' before starting the - test. Defaults to disabled for clean test - environments. - -h, --help Show this message and exit. + -p, --package TEXT Package to source build, if more than one + available, like in a monorepo configuration. + Use it multiple times to select multiple + packages.Defaults to all the packages listed + inside the config. + --rpm_paths TEXT Path(s) to RPMs that should be installed in + the test environment. + --target TEXT Container/VM image to use. + --plans TEXT List of specific tmt plans to run. + --clean-before / --no-clean-before + Run 'tmt clean --all' before starting the + test (default: disabled). + -h, --help Show this message and exit.