typefully 0.1.0 → 0.2.0

package/README.md

@@ -1,3 +1,6 @@
+<img src="https://github.com/ahmadawais/typefully-cli/blob/main/.github/cover.png?raw=true" alt="Typefully CLI" />
+
+
 # Typefully CLI
 
 A TypeScript CLI and AI agent skill for drafting, scheduling, and managing social media posts across X, LinkedIn, Threads, Bluesky, and Mastodon.
@@ -9,7 +12,7 @@ Built on the [Typefully API](https://typefully.com/docs/api). [Typefully](https:
 ### 1. Install
 
 ```bash
-pnpm add -g typefully
+npm i -g typefully
 ```
 
 Or use directly with npx:
@@ -18,6 +21,12 @@ Or use directly with npx:
 npx typefully --help
 ```
 
+or skills for your AI agent:
+
+```bash
+npx skills add ahmadawais/typefully-cli
+```
+
 ### 2. Copy your API Key
 
 You'll need a Typefully API key. Copy an existing key or create a new one at https://typefully.com/?settings=api
@@ -31,29 +40,32 @@ typefully setup
 ```
 
 > [!TIP]
-> You can also set the API key as an environment variable: `export TYPEFULLY_API_KEY=your_key_here`
+> You can also set the API key as an environment variable: `export TYPEFULLY_API_KEY=your_key_here` but not needed if you run `typefully setup` which saves it to a config file.
 
 ### 4. Start using it
 
 ```bash
-# Create a tweet
-typefully drafts create --text "Hello, world!"
+tfly                              # interactive — pick text, platform, schedule
+tfly "Hello, world!"              # instant draft from text
 
-# Quick alias — positional text, no flags needed
-typefully create-draft "Hello, world!"
+tfly rm                           # interactive — pick drafts to delete
+tfly rm <draft_id>                # delete a specific draft
 
-# List scheduled posts
-typefully drafts list --status scheduled
+tfly drafts list --status scheduled
+tfly drafts list --json           # raw JSON for scripts/pipes
+```
 
-# Create a cross-platform post
-typefully drafts create --platform x,linkedin --text "Big announcement!"
+#### Aliases (short forms)
 
-# Schedule for next available slot
-typefully drafts create --text "Scheduled post" --schedule next-free-slot
+| Alias | Equivalent |
+|-------|-----------|
+| `tfly "text"` | `typefully drafts create --text "text"` |
+| `tfly create-draft "text"` | same, with full flag support |
+| `tfly update-draft <id> "text"` | `typefully drafts update` |
+| `tfly rm [draft_id]` | `typefully drafts delete` |
+
+<img src="https://github.com/ahmadawais/typefully-cli/blob/main/.github/image.png?raw=true" alt="Typefully CLI" />
 
-# Output raw JSON (for scripts/pipes)
-typefully drafts list --json
-```
 
 ## Output Modes
 
@@ -90,6 +102,8 @@ typefully config show
 typefully config set-default                            # interactive
 typefully config set-default 123 --location global
 typefully config set-default 123 --scope local         # --scope is an alias for --location
+typefully config set-platforms                         # interactive multiselect
+typefully config set-platforms --platforms x,linkedin,threads
 ```
 
 ### User & Social Sets
@@ -114,6 +128,7 @@ typefully drafts get <draft_id> --use-default
 typefully drafts get <social_set_id> <draft_id>
 
 # Create
+tfly "Post content"                            # alias for `typefully drafts create --text "Post content"`
 typefully drafts create --text "Post content"
 typefully drafts create -f ./post.txt                  # -f is short for --file
 typefully drafts create --text "..." --platform x,linkedin
@@ -191,7 +206,8 @@ Config files are stored as JSON with `0600` permissions:
 ```json
 {
   "apiKey": "typ_xxxx",
-  "defaultSocialSetId": 12345
+  "defaultSocialSetId": 12345,
+  "defaultPlatforms": ["x", "linkedin"]
 }
 ```
 
@@ -226,7 +242,7 @@ npx skills add ahmadawais/typefully-cli
 
 - [Typefully](https://typefully.com)
 - [API Documentation](https://typefully.com/docs/api)
-- [CLI Spec](./CLI-SPEC.md)
+- [CLI Spec](./skills/spec.md)
 
 ## License