Skip to main content

Available Flags

cloneit supports several command-line flags to customize its behavior.

Core Flags

-z, --zip
boolean
default:"false"
Download and zip directories into a compressed archive.When this flag is enabled, cloneit will download the specified GitHub directory or file and automatically create a ZIP archive of the downloaded content. The archive will be named after the downloaded directory with a .zip extension.Example:
cloneit -z https://github.com/alok8bb/cloneit
This creates a cloneit.zip file containing the downloaded repository.Example with long form:
cloneit --zip https://github.com/alok8bb/cloneit/tree/master/src
The zip feature is particularly useful when you need to archive or share the downloaded content.
-q, --quiet
boolean
default:"false"
Disable verbose logging and show only warnings and errors.By default, cloneit displays informative messages about each step of the download process (validation, downloading, completion). When quiet mode is enabled, only warning and error messages are shown.Example:
cloneit -q https://github.com/alok8bb/cloneit
Example with long form:
cloneit --quiet https://github.com/alok8bb/cloneit
Use quiet mode when running cloneit in scripts or automated workflows where you only need to see errors.
path
string
Optional destination path where the downloaded content will be saved.Specify a custom directory path where you want to save the downloaded GitHub content. If not provided, content is downloaded to the current working directory.Example:
cloneit https://github.com/alok8bb/cloneit ./downloads
This downloads the repository to the ./downloads directory.Example with absolute path:
cloneit https://github.com/alok8bb/cloneit /home/user/projects
The directory will be created if it doesn’t exist.

System Flags

-h, --help
boolean
Print help information and exit.Displays the command usage, available options, and examples.Example:
cloneit --help
-V, --version
boolean
Print version information and exit.Displays the current version of cloneit.Example:
cloneit --version

Combining Flags

You can combine multiple flags in a single command:
cloneit -zq https://github.com/alok8bb/cloneit ./my-projects
This command:
  • Downloads the repository
  • Creates a ZIP archive (-z)
  • Runs in quiet mode (-q)
  • Saves to the ./my-projects directory

Build docs developers (and LLMs) love