Skip to content

Commit

Permalink
README badge links, lints, and clippy (#1)
Browse files Browse the repository at this point in the history
* md lints and clippy lints

* markdown from the linter

* cargo fmt
  • Loading branch information
shnewto authored Dec 18, 2023
1 parent 59cd6ee commit 171f72d
Showing 1 changed file with 44 additions and 44 deletions.
88 changes: 44 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# ![cliffy](assets/cliffy.jpeg)

![build](https://github.com/davepmiller/cliflare/actions/workflows/ci.yml/badge.svg?branch=main)
![publish](https://github.com/davepmiller/cliflare/actions/workflows/publish.yml/badge.svg?branch=main)
[![build](https://github.com/davepmiller/cliflare/actions/workflows/ci.yml/badge.svg?branch=main)](<https://github.com/davepmiller/cliflare/actions/workflows/ci.yml>)
[![publish](https://github.com/davepmiller/cliflare/actions/workflows/publish.yml/badge.svg?branch=main)](<https://github.com/davepmiller/cliflare/actions/workflows/publish.yml>)
[![Coverage Status](https://coveralls.io/repos/github/davepmiller/cliflare/badge.svg)](https://coveralls.io/github/davepmiller/cliflare)
![crates.io](https://img.shields.io/crates/v/cliflare.svg)
![downloads](https://img.shields.io/crates/d/cliflare)
[![license](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)
[![crates.io](https://img.shields.io/crates/v/cliflare.svg)](<https://crates.io/crates/cliflare>)
[![downloads](https://img.shields.io/crates/d/cliflare)](<https://crates.io/crates/cliflare>)
[![license](https://img.shields.io/badge/license-MIT-green.svg)](<https://opensource.org/licenses/MIT>)

* πŸ›  CLI️ to interact with Cloudflare APIs
* πŸ₯³ An excuse to write some Rust
Expand All @@ -15,15 +15,15 @@

* [Install Rust πŸ“](https://www.rust-lang.org/tools/install)

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

* Install

```bash
cargo install cliflare
```
```bash
cargo install cliflare
```

* [Generate a Cloudflare API token πŸ“](https://developers.cloudflare.com/cloudflare-one/api-terraform/scoped-api-tokens/)
* [Grab Account And Zone IDs πŸ“](https://developers.cloudflare.com/fundamentals/setup/find-account-and-zone-ids/)
Expand All @@ -39,57 +39,57 @@

* [Token Verify πŸ“](https://developers.cloudflare.com/api/operations/user-api-tokens-verify-token)

```bash
cliflare token verify
```
```bash
cliflare token verify
```

* [Zone List πŸ“](https://developers.cloudflare.com/api/operations/zones-get)

```bash
# print out all zone info
cliflare zone list
# print only zone "name" field -- i.e. domains
cliflare zone list --domains
```
```bash
# print out all zone info
cliflare zone list
# print only zone "name" field -- i.e. domains
cliflare zone list --domains
```

* [Create a Zone πŸ“](https://developers.cloudflare.com/api/operations/zones-post)

```bash
cliflare zone create newzone.com
```
```bash
cliflare zone create newzone.com
```

* [Delete a Zone πŸ“](https://developers.cloudflare.com/api/operations/zones-0-delete)

```bash
cliflare zone delete newzone.com
```
```bash
cliflare zone delete newzone.com
```

* [List DNS Records For A Zone πŸ“](https://developers.cloudflare.com/api/operations/dns-records-for-a-zone-list-dns-records)

```bash
cliflare dns list --zone_id <ZONE_ID>
cliflare dns list -i <ZONE_ID>
cliflare dns list --zone_name <DOMAIN>
cliflare dns list -n <DOMAIN>
```
```bash
cliflare dns list --zone_id <ZONE_ID>
cliflare dns list -i <ZONE_ID>
cliflare dns list --zone_name <DOMAIN>
cliflare dns list -n <DOMAIN>
```

* [Export DNS Records For A Zone πŸ“](https://developers.cloudflare.com/api/operations/dns-records-for-a-zone-export-dns-records)

```bash
cliflare dns export --zone_id <ZONE_ID>
cliflare dns export -i <ZONE_ID>
cliflare dns export --zone_name <DOMAIN>
cliflare dns export -n <DOMAIN>
```
```bash
cliflare dns export --zone_id <ZONE_ID>
cliflare dns export -i <ZONE_ID>
cliflare dns export --zone_name <DOMAIN>
cliflare dns export -n <DOMAIN>
```

* [Import DNS Records For A Zone πŸ“](https://developers.cloudflare.com/api/operations/dns-records-for-a-zone-import-dns-records)

```bash
cliflare dns import --file <PATH> --zone_id <ZONE_ID>
cliflare dns import -f <PATH> -i <ZONE_ID>
cliflare dns import -file <PATH> --zone_name <DOMAIN>
cliflare dns import -f <PATH> -n <DOMAIN>
```
```bash
cliflare dns import --file <PATH> --zone_id <ZONE_ID>
cliflare dns import -f <PATH> -i <ZONE_ID>
cliflare dns import -file <PATH> --zone_name <DOMAIN>
cliflare dns import -f <PATH> -n <DOMAIN>
```

## Coming Soon

Expand Down

0 comments on commit 171f72d

Please sign in to comment.