rentalot-cli

module
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 9, 2026 License: MIT

README

rentalot-cli

CLI tool for managing Rentalot rental properties, contacts, and workflows

Install

Go install:

go install github.com/Rentalot-ai/rentalot-cli/cmd/rentalot@latest

Go get (library):

go get github.com/Rentalot-ai/rentalot-cli

From source:

git clone https://github.com/Rentalot-ai/rentalot-cli.git
cd rentalot-cli
make build    # Binary at bin/rentalot

Usage

rentalot --help

Library Usage

import "github.com/Rentalot-ai/rentalot-cli/pkg/rentalotcli"

AI Agent Skill

This project ships a SKILL.md following the Agent Skills open standard. Install it so your coding agent knows all commands and options.

Quick install with skills CLI (by Vercel Labs):

npx skills add Rentalot-ai/rentalot-cli
Manual install

Claude Code — Skills live in ~/.claude/skills/ (global) or .claude/skills/ (project-local).

# Global — available in all projects
mkdir -p ~/.claude/skills/rentalot-cli
curl -fsSL https://raw.githubusercontent.com/Rentalot-ai/rentalot-cli/main/.skills/default/SKILL.md \
  -o ~/.claude/skills/rentalot-cli/SKILL.md

# Project-local — checked into this repo only
mkdir -p .claude/skills/rentalot-cli
curl -fsSL https://raw.githubusercontent.com/Rentalot-ai/rentalot-cli/main/.skills/default/SKILL.md \
  -o .claude/skills/rentalot-cli/SKILL.md

Codex CLI — reads skills from ~/.codex/skills/ (global) or .codex/skills/ (project-local).

# Global
mkdir -p ~/.codex/skills/rentalot-cli
curl -fsSL https://raw.githubusercontent.com/Rentalot-ai/rentalot-cli/main/.skills/default/SKILL.md \
  -o ~/.codex/skills/rentalot-cli/SKILL.md

# Project-local
mkdir -p .codex/skills/rentalot-cli
curl -fsSL https://raw.githubusercontent.com/Rentalot-ai/rentalot-cli/main/.skills/default/SKILL.md \
  -o .codex/skills/rentalot-cli/SKILL.md

Or pass directly: codex --instructions .skills/default/SKILL.md

Development

make build          # Build binary
make test           # Run tests
make lint           # Run linters
make format         # Format code

Shell Completion

# Bash
source <(rentalot completion bash)

# Zsh
source <(rentalot completion zsh)

# Fish
rentalot completion fish > ~/.config/fish/completions/rentalot.fish

License

MIT

Directories

Path Synopsis
cmd
rentalot command
internal
version
Package version holds rentalot-cli version information.
Package version holds rentalot-cli version information.
pkg
rentalotcli
Package rentalotcli provides the core library for rentalot-cli.
Package rentalotcli provides the core library for rentalot-cli.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL