Skip to main content

Quick Start Guide

Welcome to Unoplat Code Confluence - Your Gateway to Code Understanding!

Current Status

🔄 Unoplat Code Confluence currently supports Python codebases and is in alpha stage. We're actively working on expanding language support and features. While in alpha stage, it's best suited for developers and tech enthusiasts who enjoy exploring new tools, don't mind a few rough edges, and are willing to provide feedback as we work towards establishing a complete end-to-end workflow!

Introduction​

The current version supports parsing codebases and exporting a JSON representation of code graph. For more details, check out:

Prerequisites​

Before you begin, ensure you have the following tool installed:

ToolPurpose
🐳 Docker & Docker Compose »For running services

Setting Up Code Confluence​

Follow these steps to set up Code Confluence:

  1. Create Project Directory and Download Configuration:

    mkdir -p code-confluence && cd code-confluence

    # Download Docker Compose file
    curl -O https://raw.githubusercontent.com/unoplat/unoplat-code-confluence/refs/heads/main/prod-docker-compose.yml

  2. Launch Services:

    docker compose -f prod-docker-compose.yml up -d

  3. Verify Deployment:

    docker compose -f prod-docker-compose.yml ps

Running the Application​

1. Access the Web Interface​

2. Enter Your GitHub Personal Access Token (PAT)​

  • When prompted, enter a GitHub PAT with read access to the repositories you want to ingest.
  • This is required for Code Confluence to clone and analyze your repositories.

Enter GitHub PAT Token

Getting a GitHub PAT

If you don't have a GitHub PAT:

  1. Click "Generate new token on github (classic)"
  2. Click "Generate token" and copy it in the dialog box.

3. Ingest Repository​

You can ingest repositories from two sources:

A. Search for GitHub Repositories​

  • Press s or S (Shift + s) to open the search dialog.
  • You can search through your personal, public, and open source repositories.

Search for Repository

B. Browse Local Git Repositories​

  • Click on the Local Repository tab to switch to local repository onboarding.
  • Click the Browse button to select a local Git repository from your machine.

Local Repository Onboarding

Docker Configuration for Local Repositories

The Docker Compose is pre-configured with volume mounting (${HOME}/unoplat/repositories:/root/.unoplat/repositories) and sets the environment variable REPOSITORIES_BASE_PATH=/root/.unoplat/repositories in the flow-bridge service to enable local repository ingestion.

Before using local repositories, create the required directory on your host machine and clone your Git repositories into this path:

mkdir -p ~/unoplat/repositories

You can modify these paths in the Docker Compose file to match your preferred directory structure if needed, but ensure the volume mount path remains consistent with the REPOSITORIES_BASE_PATH environment variable in the code-confluence-flow-bridge service configuration.

4. Continue with Repository Configuration​

  • For GitHub repositories: In the Actions column, click on Ingest Repo for the repository you want to analyze.
  • For local repositories: After selecting your local repository, click Continue to Configuration to proceed.

Ingest Repo Action

5. Configure Repository & Codebase​

  • A Repository Dialog Configuration will open up with automatic codebase detection capabilities.
  • Code Confluence will automatically detect Python projects and their main directories within the repository.

Automatic Codebase Detection

  • You can choose to Detect Codebases Automatically (recommended) or configure manually if needed.
  • The automatic detection will analyze the repository structure and suggest appropriate configurations for:
    • Root Packages: Automatically identified main modules/packages
    • Codebase Folders: Detected project directories
    • Package Manager: Automatically detected (e.g., uv, pip, poetry)
    • Programming Language: Currently supports Python

Example: Automatic Detection Results​

When automatic detection completes, you'll see the detected codebases:

Automatically Detected Codebases

  • Review the automatically detected configurations and make any necessary adjustments.
  • Once satisfied with the detection results, click Submit Repo to start the ingestion process.

6. Enable Developer Mode​

  • Navigate to Settings > Developer Mode, and toggle the switch on to unlock infrastructure tooling.
  • Once enabled, you will see two new tools:

Developer Mode

Workflow Orchestrator​

  • Access and manage automated workflows
  • View execution logs and debug orchestration issues
  • Monitor real-time workflow performance
  • Click the "Workflow Orchestrator" button to open the temporal workflow orchestrator dashboard.

Knowledge Graph​

  • Explore the knowledge graph, inspect entities and relationships, and debug data connections
  • Click the "Knowledge Graph" button to open the Neo4j Browser directly
  • When Neo4j Browser opens, you'll be prompted to log in with: 
    Username: neo4j
    Password: password
  • Once logged in, try this query to explore your code graph: 
    MATCH (n) 
    RETURN n 
    LIMIT 25
tip

The above query displays the first 25 nodes in your code graph, perfect for a quick overview!

Troubleshooting​

Need assistance? We're here to help!

Support Options​

  1. GitHub Issues

    • 📝 Visit GitHub Issues » to:
      • Report bugs or request features
      • Browse existing solutions
      • Get developer support

  2. Community Support

note

Remember to check existing issues before creating a new one!

This documentation is powered by Docusaurus, making it easy to maintain and extend.