Blog · How to use CF Ready

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

Discover how to use CF Ready, an open-source CLI for Cloudflare Go-Live Readiness, with this practical tutorial.

Installing and running CF Ready on a computer.

Installing CF Ready

To get started with CF Ready, you'll need to install it on your machine. You can do this using npm or npx. To install using npm, run the following command in your terminal: `npm install @orangecloud/cf-ready`. If you prefer to use npx, you can install CF Ready as a one-time execution by running `npx @orangecloud/cf-ready`. Both methods will install CF Ready and its dependencies.

Once the installation is complete, you can verify that CF Ready has been installed correctly by running `cf-ready --version` in your terminal. This will display the version number of CF Ready that you've installed.

Running a Scan with CF Ready

After installing CF Ready, you're ready to run your first scan. To do this, navigate to the root directory of your project and run `cf-ready scan`. This command will start the scanning process, which may take a few minutes to complete, depending on the size of your project.

Once the scan is complete, CF Ready will generate a readiness report that highlights any areas where your project may need improvement. You can view this report by running `cf-ready report` in your terminal.

Understanding Your Readiness Report

The readiness report generated by CF Ready provides a detailed overview of your project's readiness for Cloudflare Go-Live Readiness. The report includes sections on performance, security, and best practices, as well as recommendations for improvement.

To get the most out of your readiness report, it's a good idea to review it carefully and address any areas of concern. You can use the report as a checklist to ensure that your project meets the requirements for Cloudflare Go-Live Readiness.

Using the Web Agent with CF Ready

CF Ready also includes a Web Agent that allows you to monitor your project's performance and security in real-time. To use the Web Agent, navigate to the root directory of your project and run `cf-ready web-agent`. This will start the Web Agent, which will display a dashboard with key performance and security metrics.

The Web Agent provides a valuable tool for monitoring your project's performance and security, and can help you identify areas where your project may need improvement.

Optional: Using CF Ready with GitHub Actions

CF Ready can also be integrated with GitHub Actions to automate the scanning and reporting process. To do this, you'll need to create a new GitHub Actions workflow that includes the `cf-ready` command. This will allow you to run CF Ready automatically whenever changes are pushed to your repository.

Using CF Ready with GitHub Actions can help you ensure that your project remains ready for Cloudflare Go-Live Readiness at all times, and can help you catch any issues before they become problems.

Conclusion

In this guide, we've covered the basics of using CF Ready to scan and report on your project's readiness for Cloudflare Go-Live Readiness. We've also discussed how to use the Web Agent and integrate CF Ready with GitHub Actions.

If you're new to CF Ready, we encourage you to try it out and see the benefits for yourself. You can download CF Ready from the official website at https://ready.orangecloud.vn. Happy scanning!