flowmi

command module
v0.5.1 Latest Latest
Warning

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

Go to latest
Published: Mar 21, 2026 License: Apache-2.0 Imports: 1 Imported by: 0

README

Flowmi CLI

flowmi — notes, drive, email, tables, search, and more from your terminal.

CI License

Installation

curl -fsSL https://flowmi.ai/install | bash
Homebrew
brew install flowmi-ai/tap/flowmi # macOS and Linux (recommended, always up to date)
Go
go install github.com/flowmi-ai/flowmi@latest

Requires Go 1.25+.

Download binary

Download the latest release from the Releases page.

Build from source
git clone https://github.com/flowmi-ai/flowmi.git
cd flowmi
make build
cp bin/flowmi ~/.local/bin/

Requires Go 1.25+.

Quick start

# Authenticate (opens browser for OAuth2 PKCE flow)
flowmi auth login

# Or use email/password for CI/CD
flowmi auth login --email user@example.com --password '...'

# Check auth status
flowmi auth status

# Create a note
flowmi note create --subject "Hello" --content "My first note"

# List notes
flowmi note list

# Upload a file
flowmi drive upload ./report.pdf

# Send an email
flowmi email send --to user@example.com --subject "Hi" --text "Hello from Flowmi"

# Web search
flowmi search "golang best practices"

# Scrape a webpage
flowmi scrape https://example.com

Commands

flowmi auth login|status                                   Authentication
flowmi note list|create|view|edit|delete|trash|restore     Notes
flowmi drive list|upload|download|view|delete|trash|restore   Cloud drive
flowmi table list|create|view|edit|delete|trash|restore    Tables
flowmi table field add|edit|delete                         Table fields
flowmi table row list|create|view|edit|delete|query|trash|restore   Table rows
flowmi email send|list|view|delete|trash|restore           Email
flowmi email mailbox list|create|edit|delete               Mailboxes
flowmi search [web|images|news]                            Web search
flowmi scrape <url>                                        Web scraping
flowmi config set|get|list                                 Configuration
flowmi update                                              Update to latest version
flowmi completion bash|zsh|fish|powershell                 Shell completion
flowmi version                                             Version info
flowmi options                                             Show global flags

Use flowmi <command> --help for detailed usage of any command.

Output formats

All commands support --json for machine-readable output:

flowmi note list --json     # JSON output
flowmi note list             # Human-readable output (default)

Configuration

Configuration is stored in ~/.config/flowmi/ (XDG-compliant):

  • config.toml — server URLs and preferences
  • credentials.toml — tokens and API keys (0600 permissions)
flowmi config list              # Show all config values
flowmi config set api_key sk-...  # Set a value
flowmi config get api_server_url  # Get a value

Environment variables with the FLOWMI_ prefix override config file values (e.g., FLOWMI_API_KEY).

Shell completion

# Bash
source <(flowmi completion bash)

# Zsh
flowmi completion zsh > "${fpath[1]}/_flowmi"

# Fish
flowmi completion fish | source

License

Apache License 2.0

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
api
ui

Jump to

Keyboard shortcuts

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