Blog · How to use CF Ready

Get Started with CF Ready: A Step-by-Step Guide

Learn how to install, use, and customize CF Ready for Cloudflare Go-Live Readiness

A cloud infrastructure with a magnifying glass, symbolizing scanning and readiness

Installing CF Ready

To start using CF Ready, you'll need to install it on your system. You can do this using npm or npx. Run the following command in your terminal: `npx @orangecloud/cf-ready --help` to see the available options.

CF Ready is a CLI tool, so you'll need to have npm installed on your system. If you don't have npm installed, you can download it from the official website.

Running a Scan with CF Ready

Once you have CF Ready installed, you can run a scan to check your Cloudflare configuration. Run the following command: `cf-ready scan` to start the scanning process.

CF Ready will analyze your configuration and provide a readiness report, highlighting any areas that need improvement. You can customize the scanning process by using various flags and options available with the `--help` command.

Using the Web Agent

The Web Agent is a powerful feature of CF Ready that allows you to integrate your Cloudflare configuration with your CI/CD pipeline. You can use the Web Agent to automate your scanning process and get notified when your configuration is ready for Go-Live.

To use the Web Agent, you'll need to set up a GitHub Action or a similar CI/CD tool. CF Ready provides a sample GitHub Action that you can use as a starting point.

Customizing CF Ready with GitHub Actions

CF Ready provides a sample GitHub Action that you can use to automate your scanning process. You can customize the action to fit your specific needs and integrate it with your CI/CD pipeline.

To get started with the GitHub Action, you'll need to create a new file in your repository's `.github/workflows` directory. You can use the sample action provided by CF Ready as a starting point.

Fixing Flows with CF Ready

CF Ready provides a detailed readiness report that highlights any areas that need improvement. You can use this report to fix any issues and improve your Cloudflare configuration.

To fix flows with CF Ready, you'll need to identify the areas that need improvement and take corrective action. You can use the report provided by CF Ready to guide you through the process.

Conclusion

CF Ready is a powerful tool that can help you improve your Cloudflare configuration and get ready for Go-Live. By following the steps outlined in this guide, you can get started with CF Ready and start scanning your configuration today.

If you're new to CF Ready, we recommend trying it out and exploring the documentation to learn more about its features and capabilities. Happy scanning!