Skip to content

ryancormack/q-view

Repository files navigation

Q CLI Conversation Viewer

An unofficial, open-source tool for visualizing and analyzing Amazon Q Developer conversation history from Q CLI.

License: MIT TypeScript React AWS CDK

🌐 Live Demo: https://qview.chat

πŸ“Έ Screenshots

Conversation Flow View

Q CLI Conversation View Visualize the complete conversation flow with clear message type indicators and tool usage

Analytics Summary

Q CLI Summary View Get insights into tool usage patterns and conversation statistics

⚠️ Important Disclaimers

  • Unofficial Tool: This is an independent, community-created tool and is not affiliated with, endorsed by, or supported by Amazon Web Services (AWS) or the Amazon Q Developer team.
  • Open Source: This project is completely open source to ensure transparency and allow users to verify that no data is transmitted to third parties.
  • Privacy First: All conversation processing happens locally in your browser. No data leaves your device.

🎯 What This Tool Does

The Q CLI Conversation Viewer helps developers understand their Amazon Q Developer interactions by providing:

  • πŸ“Š Tool Usage Analytics - See which tools Q Developer uses most frequently and understand their parameters
  • πŸ’¬ Conversation Flow Visualization - Clear visual distinction between user prompts, tool usage, and AI responses
  • πŸ” Schema Validation - Built-in JSON schema validation for Q CLI conversation files
  • πŸ”§ Interactive Tool Exploration - Navigate between conversation summary and detailed tool specifications
  • πŸ“ˆ Usage Statistics - Understand patterns in your Q Developer interactions

πŸ”’ Privacy & Security

This tool is designed with privacy as the top priority:

  • βœ… 100% Local Processing - All conversation analysis happens in your browser
  • βœ… No Data Transmission - Your conversation files never leave your device
  • βœ… No Cookies - We don't use cookies or any tracking mechanisms
  • βœ… No Analytics - No usage tracking, telemetry, or data collection
  • βœ… No Third-Party Services - No external APIs or services are called
  • βœ… Open Source - Full source code available for inspection and verification

πŸš€ Quick Start

Using the Hosted Version

  1. Visit https://qview.chat
  2. Save your Q CLI conversation using the /save command during a chat session
  3. Upload the saved JSON file to the viewer
  4. Explore your conversation across three tabs:
    • Conversation: Message flow with visual indicators
    • Summary: Statistics and most-used tools
    • Tools: Detailed tool specifications

Running Locally

If you prefer to run the tool locally for additional privacy assurance:

# Clone the repository
git clone https://github.com/ryancormack/q-view.git
cd q-viewer

# Install dependencies
pnpm install

# Start development server
pnpm dev

# Build for production
pnpm build

Prerequisites:

  • Node.js 18+
  • pnpm 8+

πŸ“ Project Structure

β”œβ”€β”€ packages/
β”‚   β”œβ”€β”€ website/           # React frontend application
β”‚   β”‚   β”œβ”€β”€ src/          # React components and logic
β”‚   β”‚   β”œβ”€β”€ public/       # Static assets and demo files
β”‚   β”‚   └── package.json  # Website dependencies
β”‚   └── infrastructure/   # AWS CDK deployment (optional)
β”‚       β”œβ”€β”€ lib/         # CDK stack definitions
β”‚       └── package.json # Infrastructure dependencies
β”œβ”€β”€ README.md            # This file
└── package.json         # Root workspace configuration

πŸ“‹ Supported File Format

The viewer expects Q CLI conversation files with this structure:

{
  "conversation_id": "uuid-string",
  "history": [
    [/* array of message objects per turn */]
  ],
  "transcript": ["flat text representation"],
  "tools": {
    "namespace": [
      {
        "name": "tool_name",
        "description": "What the tool does",
        "input_schema": { /* JSON Schema */ }
      }
    ]
  },
  "model": "claude-3-5-sonnet-20241022"
}

🎨 Message Types

The viewer provides visual indicators for different message types:

  • πŸ”΅ User Messages: Your prompts and inputs to Q Developer
  • ⚫ Tool Results: Results returned from tool execution
  • 🟣 Tool Use: Q Developer's tool invocations with parameters
  • 🟒 AI Responses: Q Developer's text responses and explanations

πŸ› οΈ Development

# Install all dependencies
pnpm install

# Start development server
pnpm dev

# Build all packages
pnpm build

# Type check all packages
pnpm typecheck

# Clean all packages
pnpm clean

Package-specific commands:

# Website only
pnpm --filter @q-convo-viewer/website dev
pnpm --filter @q-convo-viewer/website build

# Infrastructure only (optional)
pnpm --filter @q-convo-viewer/infrastructure deploy

🌐 Deployment (Optional)

The application can be deployed to AWS using the included CDK infrastructure:

# Deploy infrastructure (first time)
pnpm deploy:infra

# Deploy website updates
pnpm deploy:website

# Deploy both
pnpm deploy

Architecture:

  • S3 for static file hosting
  • CloudFront for global CDN
  • Route 53 for DNS
  • ACM for SSL certificates

🀝 Contributing

Contributions are welcome! This project is open source to ensure transparency and allow the community to verify its privacy claims.

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests if applicable
  5. Submit a pull request

πŸ“„ License

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

πŸ™‹β€β™‚οΈ FAQ

Q: Is this tool safe to use with sensitive conversations? A: Yes, all processing happens locally in your browser. No data is transmitted anywhere.

Q: Why is this open source? A: Transparency is crucial when handling potentially sensitive developer conversations. Open source allows you to verify that no data leaves your device.

Q: Can I run this completely offline? A: Yes, after building the project locally, it can run entirely offline.

Q: Does this work with all Q CLI conversation files? A: It's designed to work with standard Q CLI conversation JSON files. If you encounter issues, please open an issue with details.

Q: Is this affiliated with AWS or Amazon Q Developer? A: No, this is an independent, community-created tool.

πŸ”— Links


Built for Amazon Q Developer users who want to understand their AI interactions while maintaining complete privacy and control over their data.

About

No description, website, or topics provided.

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages