Skip to content

Usage

Jump to bottom
nihitdev edited this page Jul 30, 2026 · 1 revision

Usage

Run yoo inside a project directory:

yoo

For faster output without the typing animation:

yoo --fast

Commands

Command Description
yoo Start a developer session
yoo doctor Check local tools, configuration, project detection, and Git
yoo project Show project metadata, source statistics, and Git details
yoo fetch Show the development environment and current project
yoo status Alias for yoo fetch
yoo session [MINUTES] Start a local focus timer
yoo tip [PACK] Print a random tip
yoo tips List available tip packs
yoo init Create the default configuration and sample tip pack
yoo config Print the active configuration path
yoo version Print the installed version
yoo help Show the complete help message

Display options

yoo --fast
yoo --no-art
yoo --plain
yoo --name YourName
yoo --theme tokyo-night

Available themes:

  • neon
  • ocean
  • mono
  • dracula
  • tokyo-night
  • gruvbox
  • nord
  • rose-pine
  • catppuccin

Inspect a project

cd path/to/project
yoo project

This displays information such as:

  • Project name and language
  • Project version
  • Package manager
  • Source-file statistics
  • Git branch and working-tree status
  • Common repository files

Check the development environment

yoo doctor

This checks Rust, Cargo, Git, Rustfmt, Clippy, configuration, project detection, and repository state.

JSON output

Use JSON output in scripts and editor integrations:

yoo fetch --json
yoo project --json

--json cannot be combined with display options such as --plain, --no-art, or --theme.

Focus timer

Start the configured default timer:

yoo session

Start a 45-minute timer:

yoo session 45

The alternative syntax is:

yoo session --minutes 45

Tips

Print a tip from the configured pack:

yoo tip

Select a specific pack:

yoo tip rust

List all available packs:

yoo tips

Built-in packs include general, git, linux, and rust.

Configuration

Create the default configuration:

yoo init

Print its location:

yoo config

Configuration locations:

Windows: %APPDATA%\yoo\config.yaml
Linux:   ~/.config/yoo/config.yaml
macOS:   ~/Library/Application Support/yoo/config.yaml

Clone this wiki locally