cf README

The project's README from github.com/cloudflare/cf. As one markdown file: README.md.

cf: the agentic CLI for the entire Cloudflare API

cf is a CLI that is built for the next generation of software development:

Install the open beta today globally and run it from anywhere:

npm i -g cf

cf (cloudflare/cf)

cloud-native
Searching Database…

896 ·GitHub
What is this?cf is a command-line tool that covers the entire Cloudflare API, built for 'the next generation of software development' where both humans and AI agents drive the CLI.
Is this a regular CLI, or is it built specifically for AI agents?It is a CLI meant to be driven by both people and AI agents: it ships with bespoke command search and steering so an agent can find the right Cloudflare command, and JSON is the default output format.
How do I install and start using cf?You install the open beta globally and can then run the cf command from any directory, with no extra project setup needed first.
Do I need anything installed before running cf?cf is a Node.js/TypeScript CLI package, so you need Node.js available to install and run it globally.
Is cf stable enough to rely on right now?No, it is currently distributed as an open beta, so command coverage and behavior are still expected to change.
Why is JSON the default output instead of plain text?cf pretty-prints JSON for humans and condenses it for agents, which saves context tokens when an AI agent is parsing the output.
What is cloudflare.config.ts?It is the new unified configuration format for Cloudflare products, starting with Workers, written in TypeScript so both your editor and your agent's LSP get type safety and accuracy.
Does cf come with a local dev server?Yes, Vite is the default local development server used by cf, bundled with a plugin suite aimed at both developers and framework authors.
Creator
cloudflare
Size
202.8 MB
Stars
896
Age
27d
Commits · 90 Days