diff --git a/pages/common/satis.md b/pages/common/satis.md new file mode 100644 index 000000000..26bc5bf4c --- /dev/null +++ b/pages/common/satis.md @@ -0,0 +1,23 @@ +# satis + +> The command-line utility for the Satis static Composer repository. + +- Initialise a Satis configuration: + +`satis init {{satis.json}}` + +- Add a VCS repository to the Satis configuration: + +`satis add {{repository_url}}` + +- Build the static output from the configuration: + +`satis build {{satis.json}} {{path/to/output_directory}}` + +- Build the static output by updating only the specified repository: + +`satis build --repository-url {{repository_url}} {{satis.json}} {{path/to/output_directory}}` + +- Remove useless archive files: + +`satis purge {{satis.json}} {{path/to/output_directory}}`