CLI Best Practices
Practical habits that keep the Heyweek CLI fast, safe, and reliable in daily use. The CLI rewards a little discipline. A clean configuration, consistent…
Documentation
#cli
24 articles tagged
Articles
CLI Commands Reference
A reference for every Heyweek CLI command group, its subcommands, and key flags. The commands are identical across macOS, Linux, and Windows.
auth
Manage authentication and your user token for the Heyweek CLI. hw auth handles logging in to your Heyweek account, refreshing your token, and logging out.…
client
Manage workspace clients from the command line. hw client lets you create, list, edit, and delete clients in your active workspace. Clients can then be…
log
Manage workspace time logs from the command line. hw log lets you create, list, edit, and delete work log entries in your active workspace. Logs record…
project
Manage workspace projects from the command line. hw project lets you create, list, edit, and delete projects in your active workspace. Projects can be…
timer
Manage the workspace timer from the command line. hw timer lets you start a running timer, check its status, and stop it. The timer tracks time live in…
workspace
Manage workspaces from the command line. hw workspace lets you create, list, and edit workspaces, view info about the active workspace, and switch between…
CLI Configuration
Configure the Heyweek CLI to match your workflow. This guide covers authentication, the config file, workspace context, environment variables, and how…
CLI Installation
This guide will help you install the Heyweek CLI on your system. The CLI is available for macOS, Windows, and Linux distributions (including Ubuntu,…
CLI Integrations
Wire the Heyweek CLI into the tools you already use to automate the work around your work. The Heyweek CLI doesn't expose a separate API — integration…
Heyweek CLI Overview
The Heyweek command-line interface (CLI) brings your Heyweek account to the terminal. Track time, manage projects and clients, edit work logs, and switch…
CLI Scripting
The Heyweek CLI (hw) is designed to be scriptable. Because every command is a plain executable that reads flags and writes to standard output, you can…
Advanced Scripting
Advanced patterns, cron automation, testing, and best practices for Heyweek CLI scripts. Maintain state between runs by saving a value to a file. This…
Node.js Scripting
Use Node.js and the child_process module to script the Heyweek CLI. Promisify exec and wrap hw in a helper that returns its output:
Python Scripting
Drive the Heyweek CLI from Python with the subprocess module to automate your workflow. Wrap hw in a helper that runs a command and checks its exit code:
Shell Scripting
Wrap the Heyweek CLI in shell scripts to automate time tracking with loops, variables, and error handling. A simple script that ensures a timer is…
Troubleshooting
Common issues and solutions for the Heyweek CLI. After installation, if the hw command isn't recognized, your terminal probably can't find the binary on…
CLI Workflows
Common workflows for the Heyweek CLI, built entirely from real commands. Each example combines the timer, project, client, log, and workspace commands…
Advanced Workflows
Power-user techniques for the Heyweek CLI: shell aliases, scripting patterns, and troubleshooting — all built from real commands.
Project & Client Workflows
Manage projects and clients without leaving your terminal. Projects can be linked to a client so your work stays organized.
Team & Automation Workflows
If you work across multiple clients or teams, each lives in its own workspace. Switch between them from the CLI, and wrap the real commands in small bash…
Client View
Give your clients a dedicated portal into a project — without handing over access to your workspace. Client View is a shareable, branded page where the…
Clients
Manage your client relationships, contacts, and billing information in one place. Clients sit at the heart of Heyweek — every project, invoice, and report…