Documentation Overview

Welcome to the CodeLogician documentation. Here you'll find comprehensive guides and documentation to help you start working with CodeLogician as quickly as possible.

What is CodeLogician?

CodeLogician is a neurosymbolic agentic governance platform for AI coding. It combines formal verification with practical software development to provide mathematical proofs about your code's behavior, detect redundant rules, and ensure correctness with certainty.

CodeLogician overview - What is CodeLogician?

It helps your coding agent think logically about the code it's producing and test cases it's generating. The fundamental flaw that all LLM-powered assistants have is the reasoning they're capable of is based on statistics, while you need rigorous logic-based automated reasoning.

  • Generated code is based on explainable logic, not pure statistics
  • Generated test cases are generated come with quantitative coverage metrics
  • Generated code is consistent with the best security practices leveraging formal verification
CodeLogician overview

Where should I use CL?

Reasoning domainsExamples
Software Abstraction
High
CodeLogician applicability
Architectural designs
SysML v2 modeling, verification and testing
Multi-system integration testing
Integration testing
Functional requirements
Requirements modeling and functional testing
Low-level application-specific
SQL injection issues
Hardware-related concerns
Memory allocation in C++
Low

Getting Started

To run CodeLogician, please obtain an Imandra Universe API key available (there's a free starting plan) at https://universe.imandra.ai and make sure it's available in your environment as IMANDRA_UNIVERSE_KEY.

Three typical workflows:

  1. DIY mode - this is where your agent (e.g. Grok) uses the CLI to:
  • Learn how to use IML/ImandraX via doc command (e.g. codelogician doc --help)
  • Synthesizes IML code and uses the eval command to evaluate it
  • If there're errors, use codelogician doc view errors command to study how to correct the errors and re-evalute the code
  1. Agent/multi-agent mode - CodeLogician Agent is a Langgraph-based agent for automatically formalizing source code.
  • With agent command you can formalize a single source code file (e.g. codelogician agent PATH_TO_FILE)
  • With multiagent command you can formalize a whole directory (e.g. codelogician agent PATH_TO_DIR)
  1. Server - this is a "live" and interactive version of the multiagent command, but one you can interact with and one that "listens" to live updates and automatically updates formalization as necessary. You can start the server and connect to it with the TUI (we recommend separate terminal screens).

Getting Started

New to CodeLogician? Start here:

Ways to Use CodeLogician

VS Code Extension

Bring formal verification directly into your VS Code workflow with the CodeLogician extension.

CodeLogician Agent

The CodeLogician agent is the core of the system, providing intelligent code analysis and formal verification capabilities.

Real-World Examples

Learn from production use cases that demonstrate CodeLogician's capabilities:

Additional Resources

Need Help?

If you need help with CodeLogician:

  • Review the comprehensive guides in each section
  • Explore real-world examples and walkthroughs
  • Check out the Python API reference
  • Read the blog for tutorials and best practices

Important: To use CodeLogician, you need an Imandra Universe API key. Sign up for free to get started!

Ready to dive in? Choose a section from the sidebar to get started!