- Ready for use via Cloudflare Workers and Durable Objects ⛅️
- No hosting, domains, VPS or database plans required 💸
- No need to configure servers or databases ✨
- Built-in support for customizable Badges 🛡️
- CLI helper to simplify the creation, backup, and maintenance of your counter 🛠️
- Countty can be used both as a plug-in and a standalone Worker app ⚡️
To automatically create all necessary files and install the dependencies, run in an empty directory:
npx -y countty@latest init- Easy: Creates a self-contained Worker exclusive for Countty.
npx -y countty@latest init --plugin- Advanced: It exposes Countty routes, allowing integration with different routes, as well as customization of existing ones.
npm run devExample:
![]()
Tip
- You can test it locally, even if you don't have a Cloudflare account.
- Creates a new counter for the specified slug.
- Authentication: Required.
- Method:
POST. - Body:
slug: string.
- Increments a view and returns the number of views for the specified slug.
- Returns
0when the slug does not exist. - Authentication: Public.
- Method:
GET.
Examples:
<url>/views?slug=github:profile
<url>/badge?slug=github:profileTip
🛡️ You can customize your Badge, for example:
- label:
<url>/badge?slug:github:profile&label=views- Default:
views.
- Default:
- labelColor:
<url>/badge?slug:github:profile&labelColor=70a1ff- Label color.
- color:
<url>/badge?slug:github:profile&color=98cc00- Views background color.
- style:
<url>/badge?slug:github:profile&style=flat- Supported:
flat,flat-square,plastic,social, andfor-the-badge.
- Supported:
- logo:
<url>/badge?slug:github:profile&logo=PHN2Zy...C9zdmc+- An SVG directly encoded to Base64.
- Peek the view counter for the specified slug.
- Returns
0when the slug does not exist. - Authentication: Public.
- Method:
GET.
Example:
<url>/peek?slug=github:profile- Permanently removes the specified slug.
- Authentication: Required.
- Method:
POST. - Body:
slug: string.
- Backup the Countty used table and returns the SQL dump as plain text.
- Authentication: Required.
- Method:
POST.
- Returns the number of slugs and list all Countty slugs.
- Authentication: Required.
- Method:
POST.
⚠️ Permanently reset the Countty Durable Object.- Authentication: Required.
- Method:
POST.
⚠️ Drop the Countty used table if it exists, then run the SQL dump.- ℹ️ Experimental.
- Authentication: Required.
- Method:
POST. - Body:
string(send the SQL backup content directly).
Note
⚠️ Theresetandrestoreroutes are destructive actions: use them carefully.
For production use, you will need a Cloudflare account to proceed.
npm run deployTip
- You can have an
.envfile for development and another for production. - Change your Worker app name using the
nameproperty inwrangler.jsonc.- Default is
countty.
- Default is
To safe use your token in production without uploading .env files, you can create a secret:
npm run secret # Then put your COUNTTY_TOKEN from .env file.Important
By default, the token is randomly generated with 100 characters and the URL is "http://localhost:8787". You can change it in the .env file, for example:
COUNTTY_URL='https://countty.<your-subdomain>.workers.dev'
COUNTTY_TOKEN='your-secret-token'Countty includes a CLI helper to simplify the creation, backup, and maintenance of your counter directly from the terminal.
npx countty create <slug>: Create a new counter.npx countty views <slug>: View and increment counter statistics.npx countty peek <slug>: View counter statistics.npx countty remove <slug>: Remove permanently an existing counter.npx countty backup: Backup the Countty used table to./backups/directory.npx countty list: Return the number of slugs and list all Countty slugs.npx countty reset:⚠️ Reset all counters permanently.npx countty restore <backupPath>.sql:⚠️ Drop the Countty used table if it exists, then run the SQL dump (experimental).
--help- Show help message.--env <path>- Specify a custom .env file path.
Note
- ℹ️ It's not possible to use custom routes with the Counter CLI helper.
⚠️ Theresetandrestorecommands are destructive actions: use them carefully.
Tip
The CLI automatically loads environment variables from .env file in your current directory. Use --env flag to specify a different location.
You can customize your Countty using the options available at the time of creation:
import type { CounttyOptions } from 'countty';
import { createCountty } from 'countty';
const options: CounttyOptions = {
// Specifies the table name in the SQLite Durable Object.
table: 'countty',
// Sets the global cache for `views`, `badge`, and `list` routes (default: no cache).
cacheMs: 1000,
// Rate limiting configuration:
rateLimit: {
maxRequests: 100, // Maximum requests allowed in the time window.
windowMs: 10000, // Time window in milliseconds.
blockDurationMs: 10000, // Block duration when limit exceeded.
},
};
const { Worker, Countty } = createCountty(options);
// ...Tip
You can also personalize the cacheMs option directly from each route.
Important
Changing the table name won't migrate data from a previous table.
The init command installs three dependencies in package.json:
- countty (itself 👋)
Note
countty subdependencies
- badge-maker: To create badges dynamically.
- bcryptjs: For improved authentication security with native Node.js.
- lru.min: For cache in memory, performance improvements, and an efficient rate limit.
- Workers: https://developers.cloudflare.com/workers/platform/pricing/
- Durable Objects: https://developers.cloudflare.com/durable-objects/platform/pricing/
- SQLite: https://developers.cloudflare.com/durable-objects/platform/pricing/#sqlite-storage-backend
Data retrieved from the above links on October 1, 2025:
100,000requests per day.- No charge for duration.
10 millisecondsof CPU time per invocation.
100,000requests per day.13,000 GB-sper day (gigabyte-seconds of compute duration while the object is active in memory).
5 millionrows reads per day.100,000rows writes per day.5 GB(total) SQL Stored data.
Countty itself does not collect, process, or analyze any personal data whatsoever. However, Cloudflare Workers provides observability dashboards that may log request metadata for monitoring purposes.
- All view count data is stored exclusively in your own Durable Object instance and remains under your full control.
Tip
For even more privacy, you can add the option "send_metrics": false to your wrangler.jsonc file.
Countty is under the AGPL-3.0 License.
Copyright © 2025-present Weslley Araújo and Countty contributors.