https://github.com/halo-dev/cli
CLI for Halo
https://github.com/halo-dev/cli
agent-skills agents halo halo-cli openclaw skills
Last synced: 2 months ago
JSON representation
CLI for Halo
- Host: GitHub
- URL: https://github.com/halo-dev/cli
- Owner: halo-dev
- License: mit
- Created: 2026-03-18T09:18:40.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2026-03-19T15:43:16.000Z (3 months ago)
- Last Synced: 2026-03-20T00:50:33.577Z (3 months ago)
- Topics: agent-skills, agents, halo, halo-cli, openclaw, skills
- Language: TypeScript
- Homepage:
- Size: 281 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Halo CLI
[简体中文](./README.zh-CN.md)
A command-line tool for managing [Halo](https://www.halo.run) instances.
[](https://asciinema.org/a/LiTFpF00sFMKnNGX)
## Install
```sh
npm install -g @halo-dev/cli
```
The installed binary is:
```sh
halo
```
Check the version:
```sh
halo --version
```
## Requirements
- Node.js `>= 22`
## Quick Start
### Login with a bearer token
```sh
halo auth login \
--profile local \
--url http://127.0.0.1:8090 \
--auth-type bearer \
--token
```
### Login with Basic Auth
Before using Basic Auth, make sure your Halo instance enables it.
Start Halo with:
```sh
--halo.security.basic-auth.disabled=false
```
Then login:
```sh
halo auth login \
--profile local \
--url http://127.0.0.1:8090 \
--auth-type basic \
--username admin \
--password
```
### Verify the current profile
```sh
halo auth current
halo auth profile list
```
## Common Usage
Get help:
```sh
halo --help
halo auth --help
halo post --help
halo single-page --help
```
Example root help output:
```text
halo/1.0.0
Usage:
$ halo [options]
Commands:
auth Authentication commands
post Post management commands
single-page Single page management commands
search Search public site content
plugin Plugin management commands
theme Theme management commands
attachment Attachment management commands
backup Backup management commands
moment Moment management commands
comment Comment management commands
notification Notification management commands
For more info, run any command with the `--help` flag:
$ halo auth --help
$ halo post --help
$ halo single-page --help
$ halo search --help
$ halo plugin --help
$ halo theme --help
$ halo attachment --help
$ halo backup --help
$ halo moment --help
$ halo comment --help
$ halo notification --help
Options:
-h, --help Display this message
-v, --version Display version number
```
Use a specific saved profile:
```sh
halo post list --profile production
```
Use JSON output for scripting:
```sh
halo post list --json
halo single-page get about --json
```
Enable shell completion:
For `bash`:
```sh
eval "$(halo completion bash)"
```
For `zsh`:
```sh
eval "$(halo completion zsh)"
```
After enabling completion, you can use Tab to complete commands such as:
```sh
halo
halo auth
halo comment reply
```
## Main Command Areas
Halo CLI currently includes these command groups:
- `auth`
- `post`
- `single-page`
- `search`
- `plugin`
- `theme`
- `attachment`
- `backup`
- `moment`
- `comment`
- `notification`
For details on any command, use `--help`.
## Agent Skills
This package also ships with reusable skills under the root `skills/` directory.
Included skills:
- `halo-cli`
- `halo-cli-shared`
- `halo-cli-auth`
- `halo-cli-content`
- `halo-cli-search`
- `halo-cli-operations`
- `halo-cli-moderation-notifications`
Add the skills with:
```sh
npx skills add halo-dev/cli
```
Recommended starting point after installation:
```sh
skills/halo-cli/SKILL.md
```
## Configuration
Profile metadata is stored in:
- `$HALO_CLI_CONFIG_DIR/config.json` if `HALO_CLI_CONFIG_DIR` is set
- otherwise `$XDG_CONFIG_HOME/halo/config.json`
- otherwise `~/.config/halo/config.json`
Credentials are stored in the system keyring.
## Development
Useful commands:
```sh
pnpm typecheck
vp lint
vp test
vp pack
```
## Publishing
Before publishing, verify the package contents:
```sh
npm pack --dry-run
```
Create a release version locally without publishing to npm:
```sh
vp run release
vp run release:dry
```
This uses `release-it` to bump the version, create a release commit and git tag, push them upstream, and create a GitHub Release.
It does not publish the package to npm.
The published package should include:
- `dist/`
- `skills/`
- `README.md`
- `LICENSE`
## License
MIT