Forrest logo
back to the satis tool

satis:tldr:21a7b

satis: Build the static output from the configuration.
$ satis build ${satis-json} ${path-to-output_directory}
try on your machine

The command satis build ${satis-json} ${path-to-output_directory} is used to build a Composer repository using Satis.

Explanation of the command arguments:

  • ${satis-json}: This is the path to the Satis JSON configuration file. Satis JSON file contains the information about the packages and repositories that should be included in the Composer repository. It specifies the package names, versions, and where to fetch them from (e.g., GitHub, GitLab, a private repository, etc.). The JSON file is used as a blueprint to build the Composer repository.

  • ${path-to-output_directory}: This specifies the directory where the Composer repository should be generated. Satis will create all necessary files and directories for the Composer repository in this location. The output directory can be any valid directory path on the system.

Overall, by running this command, Satis will use the provided Satis JSON configuration file to determine the packages and repositories that should be included in the Composer repository, and it will generate the repository files in the specified output directory. Afterward, the output directory can be shared with others or used as a Composer repository source to fetch and install packages using Composer.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the satis tool