LumifyHub CLI
Sync your LumifyHub pages locally as markdown files. Search, edit, and push changes back to the cloud.
Installation
Install the CLI globally using npm:
npm install -g lumifyhub-cliGetting Started
Follow these steps to start syncing your pages:
1. Login with your LumifyHub account
lh login2. Pull your pages to your local machine
lh pull3. Edit pages with your favorite editor
# Pages are stored in ~/.lumifyhub/pages/
# Edit any .md file with your favorite editor
code ~/.lumifyhub/pages/4. Push changes back to LumifyHub
lh pushCommands
lh login
Authenticate with your LumifyHub account. Opens a browser to generate an API token.
lh loginlh pull
Download all your pages as markdown files. Only pulls pages that have changed since your last pull.
lh pullOptions:
-w, --workspace <slug>Only sync pages from a specific workspace-f, --forceOverwrite local changes without promptinglh push
Upload local changes to LumifyHub. Supports both updating existing pages and creating new ones.
lh pushOptions:
-w, --workspace <slug>Only sync pages from a specific workspacelh search
Search your local pages by title or content.
lh search "your query"Options:
-w, --workspace <slug>Only sync pages from a specific workspacelh status
Show which local pages have been modified since the last pull.
lh statuslh whoami
Display the currently logged in user.
lh whoamilh config
Configure CLI settings like the pages directory.
lh config set pages-dir ~/my-noteslh logout
Log out and remove your stored credentials.
lh logoutAuthentication
The CLI uses API tokens for authentication. To get a token:
- Go to Account Settings in LumifyHub
- Navigate to the CLI tab
- Generate a new CLI token and paste it when prompted
File Format
Pages are stored as markdown files with YAML frontmatter containing metadata:
---
id: abc123
title: My Page Title
workspace_slug: my-workspace
updated_at: '2025-01-06T12:00:00Z'
---
# My Page Title
Your markdown content here...