Skip to content

README.md

Latest commit

 

History

History
111 lines (73 loc) · 1.89 KB

README.md

File metadata and controls

111 lines (73 loc) · 1.89 KB

TinyBones CLI

A command-line tool for managing your TinyBones blog content.

Features

  • Create new blog posts (MDX or Markdown)
  • Create new projects
  • List existing blog posts and projects
  • Update your blog with the latest TinyBones template

Installation

From your project root, run:

# Install the CLI tool dependencies and link it globally
npm run setup-cli

Or manually:

# Navigate to the CLI directory
cd scripts/tinybones-cli

# Install dependencies
npm install

# Link the CLI to make it available globally
npm link

Usage

Once installed, you can use the CLI with either:

# Using the npm script
npm run tb -- <command> <args>

# Or directly if linked globally
tinybones <command> <args>

Available Commands

Create a new blog post

tinybones create new-post

You'll be prompted for:

  • Title
  • Description
  • Format (MDX or Markdown)

The tool will create a new directory in src/content/blog/ with a slug based on the title and an index file with the current date as the publication date.

Create a new project

tinybones create new-project

You'll be prompted for:

  • Title
  • Description

The tool will create a new directory in src/content/projects/ with a slug based on the title.

List blog posts

tinybones list posts

Displays a list of all blog posts with their titles, dates, and file paths.

List projects

tinybones list projects

Displays a list of all projects with their titles, descriptions, and file paths.

Update TinyBones template

tinybones update

Updates your blog with the latest TinyBones template while preserving your content. This command:

  • Backs up your content
  • Fetches the latest template
  • Applies the template changes
  • Restores your content
  • Creates a new branch with the changes

Help

For more information, run:

tinybones --help