wamon

Wamon 🦭

A CLI tool where a ringed seal (ワモンアザラシ) praises you for tracking your daily activities!

Overview

Wamon helps you track your daily research and programming activities through a friendly CLI interface. The app features a cute ringed seal mascot that provides encouragement and keeps track of your work.

Features

• Interactive CLI interface
• Track research activities
• Record programming accomplishments
• List previous entries
• Filter records by category
• Satisfaction rating system
• Encouraging seal messages
• Weekly report to Slack

Installation

Using Prebuilt Binary (Recommended for non-developers)

1. Download the latest release from the Releases page.
2. Extract the archive and place the wamon binary in your PATH.

# macOS/Linux
chmod +x wamon
sudo mv wamon /usr/local/bin/

Using Homebrew (macOS/Linux)

If you have Homebrew installed, you can use it to install Wamon:

# Tap the repository
brew tap econron/wamon

# Install Wamon
brew install wamon

To upgrade to the latest version:

brew upgrade wamon

Using Go (for developers)

go install github.com/econron/wamon@latest

Manual Installation (for developers)

1. Clone the repository:

git clone https://github.com/econron/wamon.git
cd wamon

1. Build the executable:

make build
# or
go build -o wamon

1. Move the executable to your PATH:

sudo mv wamon /usr/local/bin/

Usage

Interactive Mode

Simply run the wamon command without arguments to enter interactive mode:

wamon

This will start an interactive session where you can:

1. Choose a category (Research, Programming, or both)
2. Enter details about your activity
3. Rate your satisfaction
4. Receive encouragement from the seal!

Listing Previous Entries

To list all your previous entries:

wamon list

Filter by category:

wamon list -c "調べ物"  # or you can input "research"
wamon list -c "プログラマ"  # or you can input programming
wamon list -c "調べてプログラマ"  # Both

Editing Entries

既存の記録を編集するには、編集したい記録のIDを指定してeditコマンドを使用します：

wamon list        # まず記録の一覧を表示してIDを確認
wamon edit [ID]   # 指定したIDの記録を編集

エディタが開き、内容を編集できます。編集後に保存すると、変更が反映されます。

Sending Weekly Report to Slack

Send a summary of the past week's activities to a Slack channel:

wamon report

初めて実行する場合は、Slack APIトークンとチャンネル名の入力を求められます。一度入力すると、これらの情報は~/.wamon/.wamon.yamlに保存され、次回以降は自動的に使用されます。

Slack Bot Tokenの取得方法

1. Slack API にアクセスし、「Create New App」をクリック
2. 「From scratch」を選択し、アプリ名とワークスペースを設定
3. 左サイドバーの「OAuth & Permissions」をクリック
4. 「Bot Token Scopes」セクションで、以下の権限を追加:
   • chat:write - パブリックチャンネルに投稿
   • chat:write.public - 参加していないパブリックチャンネルにも投稿
5. 「Install to Workspace」ボタンをクリックしてワークスペースに追加
6. インストール後に表示される「Bot User OAuth Token」（xoxb-で始まる）をコピー

チャンネルの変更方法

チャンネルを変更するには以下の方法があります:

1. 設定ファイルを直接編集:

   vim ~/.wamon/.wamon.yaml
   

   ファイル内のslack.channelの値を変更

2. 環境変数を使用:

   export WAMON_SLACK_CHANNEL="新しいチャンネル名"
   wamon report
   

3. 設定をリセットして再設定:

   rm ~/.wamon/.wamon.yaml
   wamon report  # 再度トークンとチャンネルの入力を求められます
   

Configuration

By default, Wamon stores data in ~/.wamon/wamon.db. You can customize this location:

wamon --db /custom/path/to/database.db

Slack Integration

Slackの連携を有効にするには、以下のいずれかの方法で設定を行います：

1. 環境変数を使用する方法（推奨）

# Slack設定
export WAMON_SLACK_TOKEN="xoxb-your-slack-bot-token"
export WAMON_SLACK_CHANNEL="general"  # 投稿したいチャンネル名

2. 設定ファイルを使用する方法

~/.wamon.yaml を作成または編集：

slack:
  enabled: true
  token: "xoxb-your-slack-bot-token"
  channel: "general"  # 投稿したいチャンネル名

セキュリティに関する注意

• トークンは必ず環境変数か設定ファイルで管理し、絶対にソースコードにハードコーディングしないでください
• 設定ファイルを使用する場合は、.gitignore に追加することを推奨します
• CIなどで使用する場合は、環境変数として設定することを強く推奨します

For Developers

Building from Source

# Clone the repository
git clone https://github.com/econron/wamon.git
cd wamon

# Build the application
make build

# Run tests
make test

# Run tests with race detection
make test-race

# Run tests with coverage report
make test-coverage

# Run CI tests (race detection + coverage threshold check)
make ci-test

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Before submitting your PR:

1. Make sure all tests pass with make ci-test
2. Ensure test coverage is at least 80%
3. Run go fmt ./... to format your code
4. Add/update tests for your changes

License

This project is licensed under the MIT License - see the LICENSE file for details.