Skip to main content

phylum init

Setup a new Phylum project

Usage: phylum init [OPTIONS] [PROJECT_NAME]


[PROJECT_NAME] โ€ƒ Phylum project name


-g, --group <GROUP_NAME> โ€ƒ Group which will be the owner of the project

-d, --dependency-file <DEPENDENCY_FILE> โ€ƒ Project-relative dependency file path

-t, --type <TYPE> โ€ƒ Dependency file type used for all lockfiles (default: auto) โ€ƒ Accepted values: npm, yarn, pnpm, gem, pip, poetry, pipenv, mvn, gradle, msbuild, nugetlock, gomod, go, cargo, spdx, cyclonedx, auto

-f, --force โ€ƒ Overwrite existing configurations without confirmation

-r, --repository-url <REPOSITORY_URL> โ€ƒ Repository URL of the project

-v, --verbose... โ€ƒ Increase the level of verbosity (the maximum is -vvv)

-q, --quiet... โ€ƒ Reduce the level of verbosity (the maximum is -qq)

-h, --help โ€ƒ Print help


# Interactively initialize the Phylum project.
$ phylum init

# Create the `demo` project with a yarn lockfile and no associated group.
$ phylum init --dependency-file yarn.lock --type yarn demo