Skip to content

README.md: Reformatted with Prettier #237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
olehermanse merged 1 commit into from
Jun 24, 2025
Merged

README.md: Reformatted with Prettier #237

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 34 additions & 31 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ The modules you use can be written by the CFEngine team, others in the community

## CFEngine Build Repositories

* [build-index](https://github.com/cfengine/build-index) - Index of modules
* [build-website](https://github.com/cfengine/build-website) - Website
* [cfbs](https://github.com/cfengine/cfbs) - Command line client
* [modules](https://github.com/cfengine/modules) - Official modules provided by the CFEngine team
* [module-template](https://github.com/cfengine/build-example) - Template for creating new modules
- [build-index](https://github.com/cfengine/build-index) - Index of modules
- [build-website](https://github.com/cfengine/build-website) - Website
- [cfbs](https://github.com/cfengine/cfbs) - Command line client
- [modules](https://github.com/cfengine/modules) - Official modules provided by the CFEngine team
- [module-template](https://github.com/cfengine/build-example) - Template for creating new modules

## Installation

Expand Down Expand Up @@ -40,10 +40,10 @@ pip install .

`cfbs` is implemented in Python and has a few dependencies:

* Python 3.5 or newer
* `git` CLI installed and in PATH
* `rsync`
* `autoconf` for configuring masterfiles module (typical usage but not required)
- Python 3.5 or newer
- `git` CLI installed and in PATH
- `rsync`
- `autoconf` for configuring masterfiles module (typical usage but not required)

## Usage

Expand Down Expand Up @@ -139,7 +139,10 @@ Here is an example of a `input.json` file with responses:
"while": "Do you want the module to delete more files?",
"response": [
{ "path": "/tmp/virus", "why": "It's malicious." },
{ "path": "/home/alice/.ssh/authorized_keys", "why": "She left the company." }
{
"path": "/home/alice/.ssh/authorized_keys",
"why": "She left the company."
}
]
}
]
Expand Down Expand Up @@ -249,19 +252,19 @@ We run both user-oriented and automation-oriented commands in automated tests as

These commands are centered around a user making changes to a project (manually from the shell / command line), not a computer building/deploying it:

* `cfbs add`: Add a module to the project (local files/folders, prepended with `./` are also considered modules).
* `cfbs analyse`: Same as `cfbs analyze`.
* `cfbs analyze`: Analyze the policy set specified by the given path.
* `cfbs clean`: Remove modules which were added as dependencies, but are no longer needed.
* `cfbs help`: Print the help menu.
* `cfbs info`: Print information about a module.
* `cfbs init`: Initialize a new CFEngine Build project.
* `cfbs input`: Enter input for a module which accepts input.
* `cfbs remove`: Remove a module from the project.
* `cfbs search`: Search for modules in the index.
* `cfbs show`: Same as `cfbs info`.
* `cfbs status`: Show the status of the current project, including name, description, and modules.
* `cfbs update`: Update modules to newer versions.
- `cfbs add`: Add a module to the project (local files/folders, prepended with `./` are also considered modules).
- `cfbs analyse`: Same as `cfbs analyze`.
- `cfbs analyze`: Analyze the policy set specified by the given path.
- `cfbs clean`: Remove modules which were added as dependencies, but are no longer needed.
- `cfbs help`: Print the help menu.
- `cfbs info`: Print information about a module.
- `cfbs init`: Initialize a new CFEngine Build project.
- `cfbs input`: Enter input for a module which accepts input.
- `cfbs remove`: Remove a module from the project.
- `cfbs search`: Search for modules in the index.
- `cfbs show`: Same as `cfbs info`.
- `cfbs status`: Show the status of the current project, including name, description, and modules.
- `cfbs update`: Update modules to newer versions.

They try to help the user with interactive prompts / menus.
You can always add the `--non-interactive` to skip all interactive prompts (equivalent to pressing enter to use defaults).
Expand All @@ -273,24 +276,24 @@ In order to improve the user experience we change the behavior of these, especia

These commands are intended to be run as part of build systems / deployment pipelines (in addition to being run by human users):

* `cfbs download`: Download all modules / dependencies for the project.
- `cfbs download`: Download all modules / dependencies for the project.
Modules are skipped if already downloaded.
* `cfbs build`: Build the project, combining all the modules into 1 output policy set.
- `cfbs build`: Build the project, combining all the modules into 1 output policy set.
Download modules if necessary.
Should work offline if things are already downloaded (by `cfbs download`).
* `cfbs get-input`: Get input data for a module.
- `cfbs get-input`: Get input data for a module.
Includes both the specification for what the module accepts as well as the user's responses.
Can be used on modules not yet added to project to get just the specification.
Empty list `[]` is returned if the module was found, but it does not accept any input.
* `cfbs install`: Run this on a hub as root to install the policy set (copy the files from `out/masterfiles` to `/var/cfengine/masterfiles`).
* `cfbs pretty`: Run on a JSON file to pretty-format it. (May be expanded to other formats in the future).
* `cfbs set-input`: Set input data for a module.
- `cfbs install`: Run this on a hub as root to install the policy set (copy the files from `out/masterfiles` to `/var/cfengine/masterfiles`).
- `cfbs pretty`: Run on a JSON file to pretty-format it. (May be expanded to other formats in the future).
- `cfbs set-input`: Set input data for a module.
Non-interactive version of `cfbs input`, takes the input as a JSON, validates it and stores it.
`cfbs set-input` and `cfbs get-input` can be thought of as ways to save and load the input file.
Similar to `cfbs get-input` the JSON contains both the specification (what the module accepts and how it's presented to the user) as well as the user's responses (if present).
Expected usage is to run `cfbs get-input` to get the JSON, and then fill out the response part and run `cfbs set-input`.
* `cfbs generate-release-information`: An internal command used to generate JSON release information files from the [official CFEngine masterfiles](https://github.com/cfengine/masterfiles/).
* `cfbs validate`: Used to validate the [index JSON file](https://github.com/cfengine/build-index/blob/master/cfbs.json).
- `cfbs generate-release-information`: An internal command used to generate JSON release information files from the [official CFEngine masterfiles](https://github.com/cfengine/masterfiles/).
- `cfbs validate`: Used to validate the [index JSON file](https://github.com/cfengine/build-index/blob/master/cfbs.json).
May be expanded to validate other files and formats in the future.
**Note:** If you use `cfbs validate` as part of your automation, scripts, and build systems, be aware that we might add more strict validation rules in the future, so be prepared to sometimes have it fail after upgrading the version of cfbs.

Expand Down