Skip to content

Commit 0af4b98

Browse files
committed
adds cli radme
1 parent ff67dda commit 0af4b98

2 files changed

Lines changed: 77 additions & 5 deletions

File tree

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,17 @@ A native companion app built with [Expo](https://expo.dev) and React Native.
3030
- **Dark mode** — Full light/dark theme support that follows your system preference
3131
- **OAuth** — Secure sign-in via Cal.com OAuth with PKCE
3232

33+
## CLI
34+
35+
A command-line interface for Cal.com API v2 — manage your account directly from the terminal.
36+
37+
```sh
38+
npm install -g @calcom/cli
39+
40+
calcom login # Authenticate with Cal.com
41+
calcom --help # View all available commands
42+
```
43+
3344
## Browser Extensions
3445

3546
A cross-browser extension built with [WXT](https://wxt.dev) that brings Cal.com into the pages you already use.
@@ -47,6 +58,7 @@ A cross-browser extension built with [WXT](https://wxt.dev) that brings Cal.com
4758
| Mobile app | [Expo](https://expo.dev) (React Native) with [Expo Router](https://docs.expo.dev/router/introduction/) |
4859
| Styling | [NativeWind](https://www.nativewind.dev/) (Tailwind CSS for React Native) |
4960
| Browser extension | [WXT](https://wxt.dev) (next-gen web extension framework) |
61+
| CLI | [Commander.js](https://github.com/tj/commander.js) with auto-generated API client |
5062
| Data fetching | [TanStack Query](https://tanstack.com/query) with persistent cache |
5163
| iOS widget | SwiftUI + WidgetKit |
5264
| Android widget | [react-native-android-widget](https://github.com/nickkraakman/react-native-android-widget) |
@@ -113,12 +125,13 @@ bun run ext:zip-chrome-prod
113125
## Project Structure
114126

115127
```
116-
├── app/ # Expo Router screens (tabs, modals, sheets)
128+
├── apps/
129+
│ ├── mobile/ # Expo Router screens (tabs, modals, sheets)
130+
│ └── extension/ # Browser extension source (WXT)
131+
├── packages/
132+
│ └── cli/ # Cal.com CLI (@calcom/cli)
133+
│ └── src/commands/ # CLI commands (bookings, event-types, etc.)
117134
├── components/ # Shared React Native components
118-
├── extension/ # Browser extension source (WXT)
119-
│ ├── entrypoints/ # Background script & content script
120-
│ ├── lib/ # Gmail, LinkedIn, Google Calendar integrations
121-
│ └── public/ # Extension icons & static assets
122135
├── hooks/ # Custom React hooks
123136
├── services/ # Cal.com API client & OAuth service
124137
├── contexts/ # React context providers (Auth, Query, Toast)
@@ -198,4 +211,5 @@ Any other message mentioning the bot triggers the AI scheduling assistant.
198211
- [Cal.com](https://cal.com)
199212
- [Cal.com Companion landing page](https://cal.com/app)
200213
- [Chrome Web Store](https://chromewebstore.google.com/detail/cal-companion/cbhlgojmamgmdijlkkokcmmjghgckahc)
214+
- [@calcom/cli on npm](https://www.npmjs.com/package/@calcom/cli)
201215
- [Documentation](https://cal.com/docs)

packages/cli/README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
<p align="center">
2+
<img src="https://cal.com/logo.svg" alt="Cal.com Logo" width="60" />
3+
</p>
4+
5+
<h1 align="center">@calcom/cli</h1>
6+
7+
<p align="center">
8+
Official command-line interface for Cal.com API v2
9+
</p>
10+
11+
<p align="center">
12+
<a href="https://www.npmjs.com/package/@calcom/cli"><img src="https://img.shields.io/npm/v/@calcom/cli" alt="npm version" /></a>
13+
<a href="https://cal.com/docs/api-reference/v2"><img src="https://img.shields.io/badge/API-v2-blue" alt="API v2" /></a>
14+
</p>
15+
16+
---
17+
18+
Manage your [Cal.com](https://cal.com) account directly from your terminal. View bookings, manage event types, handle schedules, and more — all without leaving the command line.
19+
20+
## Installation
21+
22+
```sh
23+
npm install -g @calcom/cli
24+
```
25+
26+
Requires Node.js 18+.
27+
28+
## Getting Started
29+
30+
```sh
31+
# Authenticate with Cal.com
32+
calcom login
33+
34+
# View all available commands
35+
calcom --help
36+
```
37+
38+
## Output Formats
39+
40+
All commands support JSON output for scripting:
41+
42+
```sh
43+
calcom bookings list --json
44+
```
45+
46+
## Self-hosted Cal.com
47+
48+
Connect to a self-hosted instance:
49+
50+
```sh
51+
calcom login --api-key your_key --api-url https://api.your-cal-instance.com
52+
```
53+
54+
## Links
55+
56+
- [Cal.com](https://cal.com)
57+
- [Cal.com API v2 Documentation](https://cal.com/docs/api-reference/v2)
58+
- [npm Package](https://www.npmjs.com/package/@calcom/cli)

0 commit comments

Comments
 (0)