JSPM

workway-assistant

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1
  • Score
    100M100P100Q23706F
  • License MIT

AI-powered workflow discovery assistant CLI for workway.halfdozen.co

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (workway-assistant) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    🤖 Workflow Assistant CLI

    npm version Node.js Version

    AI-powered workflow discovery assistant for workway.halfdozen.co

    Discover automation workflows through natural language conversation with OpenAI GPT-4o-mini. Get real-time streaming responses with direct links to live workflows.

    🚀 Quick Start

    # Install globally
    npm install -g workway-assistant
    
    # Start using immediately
    workflow-assistant examples
    workflow-assistant ask "What workflows help with productivity?"
    workflow-assistant chat

    ✨ Features

    • 🤖 AI-Powered Discovery: Natural language workflow recommendations
    • 🔄 Real-time Streaming: Live responses from OpenAI GPT-4o-mini
    • 🎨 Beautiful Interface: Colored output with professional design
    • 📱 Direct Links: Clickable links to workflow pages
    • 💬 Interactive Chat: Full conversation sessions with history
    • Zero Configuration: Works immediately after install
    • 🔗 Short Alias: Use wa instead of workflow-assistant

    📋 Commands

    Ask Quick Questions

    workflow-assistant ask "What workflows help with email automation?"
    workflow-assistant ask "Show me CRM workflows"
    workflow-assistant ask "Help me automate social media"
    
    # Short alias
    wa ask "What's the best workflow for productivity?"

    Interactive Chat

    workflow-assistant chat
    wa chat
    
    # Quick chat with single message
    workflow-assistant chat --quick "Show me data sync workflows"
    wa chat -q "Help with calendar automation"

    Examples & Help

    workflow-assistant examples    # Show example questions
    workflow-assistant test        # Test API connection
    workflow-assistant --help     # Show all commands
    wa examples                   # Short alias

    🎯 Example Usage

    $ workflow-assistant ask "What workflows help with productivity?"
    
    ┌─────────────────────────────────────────────────────────────┐
    │                                                             │
    │           🤖 WORKFLOW ASSISTANT CLI v1.0.0                  │
    │                                                             │
    │           AI-Powered Workflow Discovery                     │
    │           workway.halfdozen.co                             │
    │                                                             │
    └─────────────────────────────────────────────────────────────┘
    
    👤 You: What workflows help with productivity?
    
    🤖 Assistant:
       📱 Google Calendar to Notion (https://workway.halfdozen.co/workflows/e237bb31...)
       This workflow automatically syncs your calendar events to Notion...
       ⚙️ Setup: ~10 minutes | 📊 Difficulty: Intermediate

    🎨 Visual Features

    • 🌈 Colored Output: Brand colors with professional styling
    • 📊 Progress Indicators: Loading spinners during API calls
    • 🔗 Smart Links: Workflow URLs formatted and highlighted
    • ✨ Interactive Prompts: Beautiful command-line interface
    • 💫 Streaming Text: Real-time response streaming

    🔧 Configuration

    Environment Variables

    # Use custom API endpoint (optional)
    export API_BASE_URL="https://your-custom-endpoint.com"

    Default Behavior

    • API Endpoint: https://workway.halfdozen.co (production)
    • Conversation History: Last 10 messages preserved in chat sessions
    • Timeout: 30 seconds for API requests
    • Streaming: Real-time response display with fallback support

    🌟 Example Questions

    Try asking about these topics:

    • Email Automation: "What workflows can help me automate email tasks?"
    • Data Synchronization: "I need to sync data between Google Sheets and Notion"
    • Social Media: "How can I automate social media posting?"
    • CRM: "Show me workflows for CRM automation"
    • Productivity: "What's the best workflow for productivity?"
    • Calendar: "I want to automate my calendar management"
    • Business Automation: "What workflows are available for business automation?"

    🛠️ Development

    Local Testing

    git clone https://github.com/Half-Dozen/authorization-oauth-app.git
    cd authorization-oauth-app/workflow-assistant-cli
    npm install
    npm test

    Package Structure

    workflow-assistant-cli/
    ├── bin/
    │   └── workflow-assistant.js    # Executable CLI script
    ├── lib/                         # Reserved for future modules
    ├── package.json                 # Package configuration
    ├── README.md                    # This file
    └── LICENSE                      # MIT license

    📦 Installation Options

    npm install -g workway-assistant
    workflow-assistant examples

    Local Project

    npm install workway-assistant
    npx workflow-assistant examples

    One-time Use

    npx workway-assistant examples
    npx workway-assistant ask "help me"

    🤝 Support

    📄 License

    MIT © Half Dozen

    • Workway Platform: workway.halfdozen.co
    • Workflow Templates: Discover automation workflows
    • Integration Marketplace: Connect your favorite apps

    Made with ❤️ by Half Dozen • Powered by OpenAI GPT-4o-mini