Skip to main content

FAQs

General​

How does Komment work?​

Komment plugs seamlessly into existing developer workflows and builds sophisticated, opinionated technical wikis for your codebase from scratch.

Komment generates a wide variety of technical documentation and automatically organises it into a cohesive wiki, making it effortless for your team to search, view and share crucial knowledge about your project. Your wikis are regularly refreshed and evolve alongside your code to ensure they always remain a reliable source of truth.

Think of it as DevOps for your docs — just hook up a git repo and watch Komment unlock rich insights about it in minutes!

What types of documentation does Komment generate?​

Komment currently generates:

  • Usage instructions
  • General overviews
  • API documentation
  • Example snippets
  • Architectures diagrams
  • Implementation details
  • Security insights
  • In-code comments

Users on the Scale plan also receive documentation as markdown files submitted to their repo as a pull request, allowing them to keep their docs alongside their code.

Komment tailors documentation for each file based on its size, content, and complexity so that only the most relevant pieces from this list are produced for your code.

If your business needs a specific kind of documentation, let us know and we'll make it happen!

Which languages and platforms does Komment support?​

Languages: Komment supports over 90 programming languages! Unless you're working with a highly specialized or obscure language, it's likely that Komment can generate a wiki for your codebase. Check out the full list of supported languages here.

Git Platforms: You can use your GitHub, GitLab, or Bitbucket account to sign up and log in to Komment. You can also connect any GitHub-hosted repository to Komment for wiki generation. We plan to release adapters for GitLab and Bitbucket in 2025.

Infrastructure: Komment is available as a Software-as-a-Service (SaaS) solution at https://app.komment.ai. For teams that prefer self-hosting, Komment can be deployed on virtual private clouds (VPCs) via AWS, Azure, or GCP.

Would you benefit from having Komment available in the AWS, Azure, or GCP Marketplace? Tell us about it and get early access to our marketplace offerings!

Do you offer a free trial?​

Yes, all new users automatically receive a 14-day free trial for any paid plan. Upon completion of the trial period, your account will automatically switch to the Free plan unless you choose to upgrade your subscription.

How do I get started with Komment?​

Sign in to Komment using your email or git account, then connect a code repository. Trigger documentation jobs by clicking "Quickstart" or set up a schedule, and watch as Komment automatically builds your wiki.

How does Komment differ from other alternatives?​

Unlike other code explantation tools, Komment fully automates the creation, quality control, and ongoing maintenance of your team's technical wikis.

Instead of wasting time on analyzing code, engineering AI prompts, searching for individual answers, and manually updating docs after each code change, your team can focus on shipping with confidence. Rest assured that any changes to your codebase are automatically distilled into helpful insights.

Komment eliminates the need for developers to individually query chatbots or search for answers about your codebase. Instead of hunting for information about unfamiliar code, users can easily browse a comprehensive wiki full of sophisticated insights about your code's most recent logic.

Technical​

How does Komment ensure accuracy?​

Komment heavily leverages purpose-built algorithms, deterministic static analyses and multi-layer quality assurance to generate the best in-class output for technical documentation.

Our rules-based approach to leveraging AI in production settings offers far superior performance over LLM wrappers. We also regularly run benchmarks against our output to continuously monitor reliability and performance.

Fun fact, Komment’s own code repos are documented by Komment as well!

Can Komment document my legacy codebase?​

Absolutely! Komment can produce documentation for a wide variety of software, including legacy codebases.

You can use Komment to process decades-old systems with just as much proficiency as something developed this morning.

Will I have to change my workflow to use Komment?​

No, your development workflow will remain exactly the same! Komment is designed to integrate seamlessly into existing CI/CD workflows to generate fresh documentation behind the scenes.

Inline comments added by Komment are issued as any other Pull Request in your git repository. Just hook up your project and watch Komment keep it freshly documented — without ever getting in your way.

Documentation produced by Komment can be accessed at any time in your private Wiki.

Does Komment modify my code?​

No, Komment offers a 100% guarantee to never modify, break or otherwise compromise any portion of your codebase.

All inline text insertions are run through a rigorous multi-layer quality assurance algorithm to ensure the integrity of your software at all times.

How do I uninstall Komment?​

To uninstall Komment, make sure you’re logged into the GitHub account on which you have Komment installed. Navigate to the GitHub application settings and locate the Komment app. From there, you can configure the installation and remove Komment.

Teams​

How can Komment help my organization?​

Komment keeps your organization’s software docs consistent, accurate and always updated. Our customers use Komment to:

  • Break down knowledge silos
  • Boost developer productivity
  • Shorten new employee onboarding
  • Reduce accumulated technical debt
  • Make legacy codebases reusable
  • Increase project transferability
  • De-risk staff changes and departures
  • Assist with regulatory compliance

From developers and product managers to engineering leadership and IT security, Komment’s output delivers immediate value to a diverse range of roles and levels across the board.

How easy is it to train my team to use Komment?​

Komment is incredibly simple to set up and works silently in the background without dependence on the manual actions of your team.

Once set up, individual contributors will never have to interact with the tool for your organization to receive consistent and fresh documentation.

Your codebase will remain automatically documented behind the scenes as part of your CI/CD project workflows.

Due to this invisible low touch process, a one-off live demo (or a 10-minute pre-recorded video) is sufficient to get your team up to speed and get started with Komment.

Contact us for a demo and see how Komment can put documentation on autopilot for your org.

Is Komment useful to a non-technical audience?​

Komment generates a diverse variety of doc types that deliver value to not just individual developers, but also adjacent roles like product managers, engineering leadership, IT security, QA, compliance and even finance controllers.

Whether you’re a product manager looking for API docs that accelerate user conversion, an engineer looking for inline comments for comprehensive technical explanations, or a director looking for architecture diagrams that clarify your security posture — Komment has you covered.

More than 90% of our product roadmap is driven by direct customer feedback. Let us know what types of technical documentation are most important to you!

Privacy​

Does Komment forward my code to any third-party vendors?​

No, we never share any code or customer data with third-party services. All data crunching occurs strictly within the confines of our VPC deployment.

For organizations with enhanced security needs, Komment Enterprise supports fully self-contained on-premises deployments that ensure no code ever leaves their private mainframe.

Contact us to learn how you can readily deploy Komment to your company’s infrastructure today!

Why can’t I just use a chatbot to document my code?​

Output from LLM-based chatbots needs to be manually curated by individual developers, which means:

  • You need to add a high-touch time-consuming process to your workflow,
  • The results you’ll receive will be inconsistent and prone to hallucinatory errors,
  • Your documentation will go stale as the code continues to change, and
  • You’ll be sharing precious intellectual property with possibly unscrupulous third-parties

In comparison, Komment provides teams with a central portal to reliably produce, search, view and share all their technical docs with minimal dependence on individual users. And all this happens within the confines of their own infrastructure!

With Komment, the time that you spend on writing documentation is truly saved — not simply reallocated to assessing, modifying and supervising AI output.

How does Komment handle my data and IP?​

Komment’s pipelines are fully automated and all code is crunched without any humans in the loop. We never share your code or data externally with any third-parties, and operate completely independent of AI service vendors.

We also have a zero retention policy for all customer code and related intellectual property. We only ever store metadata about projects for reporting usage statistics in the Insights panel of your Komment dashboard.

How do I delete my Komment account?​

To delete your Komment account, please contact us. As a GDPR-compliant organization, we'll ensure all data associated with your account is securely and permanently erased.

Billing​

How many repositories can I connect to Komment?​

You can connect unlimited repositories to Komment across all supported git platforms. However, the number of repositories with Scheduled Runs enabled depends on your Subscription. You can easily check the number of concurrent repos allowed by your subscription in the Billing panel.

How does repository sponsorship work?​

When you enable automatic updates for a repository, you become its sponsor. Your Komment subscription determines the number of repositories you can sponsor.

Each time a pipeline runs on the enabled repository, the processed lines of code count against the sponsor's quota.

All collaborators on a repository can view its generated wiki, independent of who sponsors the repository.

How can I track my subscription utilization?​

You can monitor your subscription's usage on the Billing page. It provides updated numbers on the lines of code and repositories you've used up, along with your remaining quota in the current billing cycle.

How do I cancel my subscription?​

To cancel your subscription, simply downgrade to the Free subscription in the Billing section of the Komment app. Your account will automatically switch to the free tier at the end of your current billing cycle.

How do I update my payment method?​

To update your subscription's payment method, you'll need to cancel your current subscription and then re-subscribe using your new payment details.