clings

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #go #android #docker #windows #awesome #vue #awesome-list #pytorch #security #open-source

(★ 25)

a feature-rich cli for Things 3 on macOS

clings 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# clings - a feature-rich cli for Things 3 on macOS

> "clings" rhymes with "things"

> **Disclaimer:** This project is not affiliated with, endorsed by, or sponsored by [Cultured Code](https://culturedcode.com/). Things 3 is a registered trademark of Cultured Code GmbH & Co. KG. clings is an independent, open-source project that provides a command-line interface wrapper for the Things 3 application.

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![CI](https://github.com/dan-hart/clings/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/dan-hart/clings/actions/workflows/ci.yml)
[![Built with Swift](https://img.shields.io/badge/built%20with-Swift-FA7343.svg)](https://swift.org/)
[![macOS](https://img.shields.io/badge/platform-macOS-lightgrey.svg)](https://www.apple.com/macos/)
[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-support-ffdd00?logo=buymeacoffee&logoColor=black)](https://buymeacoffee.com/codedbydan)

**clings** brings the power of [Things 3](https://culturedcode.com/things/) to your terminal. Manage tasks, projects, and workflows with natural language, bulk operations, and powerful search - all without leaving the command line.

## Features

### 1. View Commands

Access all your Things 3 lists directly:

```bash
clings today             # or: clings t (default command)
clings inbox             # or: clings i
clings upcoming          # or: clings u
clings anytime
clings someday           # or: clings s
clings logbook           # or: clings l

# Organization
clings projects          # List all projects
clings areas             # List all areas
clings tags list         # List all tags
clings show <ID>         # Show details of a specific todo
```

### 2. Natural Language Task Entry

Add tasks using natural language parsing:

```bash
clings add "draft changelog entry tomorrow #docs"
clings add "replace air filter friday 3pm #home !high"
clings add "finish reading list by dec 15 #reading"
clings add "review PR // needs careful testing - check auth - verify tests"

# Supported patterns:
# - Dates: today, tomorrow, next monday, in 3 days, dec 15
# - Times: 3pm, 15:00, morning, evening
# - Tags: #tag1 #tag2
# - Projects: for <Project Name>
# - Areas: in AreaName
# - Deadlines: by friday
# - Priority: !high, !!, !!!
# - Notes: // notes at the end
# - Checklist: - item1 - item2
```

You can also use explicit flags:

```bash
clings add "Task title" \
  --when tomorrow \
  --deadline "2024-12-31" \
  --tags docs urgent \
  --project "Documentation" \
  --area "Writing" \
  --notes "Additional context"

# Preview without creating
clings add "Test task tomorrow #docs" --parse-only
```

### 3. Search and Filter

Search todos by text, or use the powerful filter command for advanced queries:

```bash
# Text search (case-insensitive, searches title and notes)
clings search "meeting"
clings find "project report"     # alias for search
clings f "status"                # short alias

# Save and reuse named views
clings views save docs-today "tags CONTAINS 'docs' AND due <= today"
clings views run docs-today
clings views list

# Advanced filtering (SQL-like query language)
clings filter "status = open"
clings filter "due < today AND status = open"
clings filter "tags CONTAINS 'urgent'"
clings filter "name LIKE '%report%'"
clings filter "project IS NOT NULL"

# Custom todo-line formatting
clings today --format "{status} {name} [{project}] {tags}"
```

**Filter operators:** `=`, `!=`, `<`, `>`, `<=`, `>=`, `LIKE`, `CONTAINS`, `IS NULL`, `IS NOT NULL`, `IN`
**Logic:** `AND`, `OR`
**Fields:** `status`, `due`, `tags`, `project`, `area`, `name`, `notes`, `created`

### 4. Todo Management

Manage individual todos:

```bash
# Show details
clings show <ID>

# Interactive pick flows
clings pick show report
clings pick complete release
clings pick cancel cleanup

# Update properties
clings update <ID> --name "New title"
clings update <ID> --notes "Updated notes"
clings update <ID> --due 2024-12-25
clings update <ID> --tags work urgent

# Complete, cancel, or delete
clings complete <ID>             # or: clings done <ID>
clings complete --title "milk"   # complete by title search
clings cancel <ID>
clings delete <ID>               # or: clings rm <ID>
clings delete <ID> --force       # skip confirmation

# Undo supported recent changes
clings undo
clings undo --show
```

### 5. Bulk Operations

Perform operations on multiple tasks using powerful filters.

> **Data Safety:** Bulk operations include built-in safety measures. Operations affecting more than 5 items require confirmation. Always use `--dry-run` first to preview changes.

```bash
# ALWAYS preview changes first with --dry-run
clings bulk complete --where "tags CONTAINS 'done'" --dry-run

# Complete matching tasks
clings bulk complete --where "tags CONTAINS 'done'"

# Cancel archive prep tasks
clings bulk cancel --where "project = 'Archive Prep'"

# Tag matching tasks as urgent
clings bulk tag "urgent,priority" --where "tags CONTAINS 'docs'"

# Move tasks to a project
clings bulk move --where "tags CONTAINS 'draft'" --to "Archive"
```

**Safety options:**
- `--dry-run` - Preview changes without applying them
- `--yes` - Skip confirmation prompts (use with caution)
- `--list` - Specify which list to operate on (default: today)

### 6. Statistics Dashboard

Track your productivity:

```bash
clings stats              # Show dashboard
clings stats trends       # Completion trends over time
clings stats heatmap      # Activity heatmap calendar
clings stats --days 7     # Limit to last 7 days

# Focus mode
clings focus
clings focus --limit 5
clings focus --format "{name} [{project}]"
```

### 7. Weekly Review

Guide yourself through a GTD-style weekly review:

```bash
clings review             # Start a new review (default)
clings review start       # Same as above
clings review status      # Show last review session info
clings review clear       # Clear review session

# Audit open projects for stalled work
clings project audit
clings project audit --json
```

### 8. Shell Completions

Generate shell completions:

```bash
clings completions bash > ~/.bash_completion.d/clings
clings completions zsh > ~/.zfunc/_clings
clings completions fish > ~/.config/fish/completions/clings.fish
```

### 9. Configuration

Set up the Things 3 auth token for features that use the Things URL scheme (`--when`, `--heading`):

```bash
# Get your auth token from Things 3:
# Settings > General > Enable Things URLs > Copy auth token

# Save it to clings
clings config set-auth-token <your-token>

# Diagnose local setup
clings doctor
clings doctor --verbose
```

The auth token is stored at `~/.config/clings/auth-token` with restricted permissions (0600).

### 10. Templates

Save reusable task blueprints with tags, notes, checklist items, and relative schedule expressions:

```bash
clings template save weekly-review "Weekly review" \
  --project "Documentation" \
  --when "tomorrow morning" \
  --checklist "Process inbox" "Review deadlines"

clings template list
clings template run weekly-review

# You can also combine a template with an explicit add command
clings add "Weekly review prep" --template weekly-review
```

## Requirements

- **macOS 10.15 (Catalina) or later**
- **Things 3 for Mac** - [Mac App Store](https://apps.apple.com/app/things-3/id904280696) or [Cultured Code](https://culturedcode.com/things/)
- **Automation Permission** - On first run, macOS will prompt you to grant automation permission

## Installation

### Homebrew (Recommended)

```bash
brew install dan-hart/tap/clings
```

To upgrade to the latest version:

```bash
brew update && brew upgrade clings
```

### From Source

```bash
# Clone the repository
git clone https://github.com/dan-hart/clings
cd clings

# Build release binary
swift build -c release

# Install to /usr/local/bin
cp .build/release/clings /usr/local/bin/
```

## Quick Start

```bash
# View today's tasks
clings today

# Add a quick task
clings add "draft changelog entry tomorrow #docs"

# Save and run a reusable view
clings views save docs-today "tags CONTAINS 'docs' AND due <= today"
clings views run docs-today

# Save and reuse a template
clings template save weekly-review "Weekly review" --when "tomorrow morning"
clings template run weekly-review

# View your inbox
clings inbox

# Search for tasks
clings search "project"

# Filter by status and date
clings filter "due < today AND status = open"

# Get productivity stats
clings stats

# See your working queue
clings focus

# Check local setup
clings doctor

# Get help on any command
clings --help
clings add --help
```

## Command Reference

### Common Options

`--help` and `--version` are available at the root command (`clings`).
Most output-oriented subcommands support:

```
--json                   Output as JSON (for scripting)
--no-color               Suppress color output
--format "{name} ..."    Custom todo-line formatting on todo-list commands
```

### Commands

| Command | Alias | Description |
|---------|-------|-------------|
| `today` | `t` | Show today's todos (default) |
| `inbox` | `i` | Show inbox todos |
| `upcoming` | `u` | Show upcoming todos |
| `anytime` | - | Show anytime todos |
| `someday` | `s` | Show someday todos |
| `logbook` | `l` | Show completed todos |
| `add` | - | Add a new todo with natural language |
| `show` | - | Show details of a todo by ID |
| `update` | - | Update a todo's properties |
| `complete` | `done` | Mark a todo as completed |
| `cancel` | - | Cancel a todo |
| `delete` | `rm` | Delete a todo (moves to trash) |
| `search` | `find`, `f` | Search todos by text |
| `views` | - | Manage saved filter views |
| `template` | - | Manage reusable task templates |
| `undo` | - | Undo the most recent supported mutation |
| `focus` | - | Show a focused queue of high-attention tasks |
| `pick` | - | Interactively pick a todo for a follow-up action |
| `doctor` | - | Check clings setup and local environment |
| `filter` | - | Filter todos using a query expression |
| `projects` | - | List all projects |
| `project` | - | Manage projects |
| `areas` | - | List all areas |
| `tags` | - | Manage tags |
| `bulk` | - | Bulk operations on multiple todos |
| `open` | - | Open Things 3 to a view or item (currently disabled) |
| `stats` | - | View productivity statistics |
| `review` | - | GTD weekly review workflow (start, status, clear) |
| `config` | - | Configure clings settings (auth token) |
| `completions` | - | Generate shell completions |

## Output Formats

### Pretty (default)

Human-readable colored output:

```
Today (3 items)
──────────────────────────────────────────────
[ ] Review PR #123        Development   Dec 15   #code
[ ] Draft changelog entry Docs          Dec 15   #docs
[x] Archive old notes    Archive       Dec 10   -
```

### JSON

Machine-readable JSON for scripting:

```bash
clings today --json | jq '.items[] | select(.tags | contains(["docs"]))'
```

## Data Safety

- **Read operations:** Use direct SQLite access to the Things 3 database (read-only)
- **Write operations:** Use Apple's JavaScript for Automation (JXA) through the official Things 3 API
- **Scheduling and headings:** Use the Things 3 URL scheme (requires auth token) since `activationDate` is read-only in JXA
- **No direct database writes:** clings never writes directly to the Things 3 database

### Best Practices

1. **Always use `--dry-run` first** when running bulk operations
2. **Start with small filters** to verify your filter expression matches what you expect
3. **Keep Things 3 backups** - Things 3 syncs to iCloud automatically

## Troubleshooting

### Automation permission error

```bash
open "x-apple.systempreferences:com.apple.preference.security?Privacy_Automation"
```

Then enable Things 3 under your terminal application.

### Things 3 not running

Things 3 must be running for clings to communicate with it via AppleScript/JXA.

### `today` shows too many tasks

This was tracked in [Issue #5](https://github.com/dan-hart/clings/issues/5). The root cause was list filter/date encoding mismatches in SQLite reads.

Details and regression coverage are documented in [docs/issues/issue-5-today-list-overcount.md](docs/issues/issue-5-today-list-overcount.md).

## Development

```bash
swift build              # Build
swift run clings today   # Run in debug mode
swift test               # Run tests
bash scripts/asp-preflight.sh --staged --strict   # Safety preflight before commit
bash scripts/release-docs-check.sh                # Help/README/docs pre-release audit
```

See [AGENTS.md](AGENTS.md) for detailed development guidelines.
Release checklist: [docs/release/help-readme-docs-checklist.md](docs/release/help-readme-docs-checklist.md)

## Contributing

Contributions are welcome! Please:

1. Fork the repository
2. Create a feature branch
3. Make changes following code quality standards
4. Run safety checks:
   - `bash scripts/asp-preflight.sh --staged --strict`
   - `git secrets --scan --cached`
5. Add tests for new functionality
6. Ensure all checks pass: `swift build && swift test`
7. Submit a pull request

Full contributor policy: [CONTRIBUTING.md](CONTRIBUTING.md)

## License

GNU General Public License v3.0 (GPLv3) - see [LICENSE](LICENSE)

## Links

- **Repository:** https://github.com/dan-hart/clings
- **Things 3:** https://culturedcode.com/things/

## Support

clings

clings 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

clings

clings 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README