Skip to content

opt9/bento

 
 

Repository files navigation

Bento logo


Free program analysis focused on bugs that matter to you.

Install, configure, and adopt Bento in seconds. Runs 100% locally.

PyPI PyPI - Downloads Issues welcome! Follow @r2cdev



Bento is a free and opinionated toolkit for gradually adopting linters¹ and program analysis² in your codebase. Be the bug-squashing advocate your team needs but (maybe) doesn’t deserve.

  • Find bugs that matter. Bento automatically enables and configures relevant analysis based on your dependencies and frameworks, and it will never report style-related issues. You won’t painstakingly configure your tooling.
  • Get started immediately. Bento doesn’t force you to fix all your preexisting issues today. Instead, you can archive them and address them incrementally when it makes sense for your project.
  • Go fast. Bento installs in 5 seconds and self-configures in less than 30. Its tools check your code in parallel, not sequentially.

Bento includes checks written by r2c and curated from Bandit, ESLint, Flake8, and their plugins. It runs on your local machine and never sends your code anywhere or to anyone.

Demonstrating Bento running in a terminal

Installation

$ pip3 install bento-cli

Bento is for JavaScript, TypeScript, and Python projects. It requires Python 3.6+ and works on macOS Mojave (10.14) and Ubuntu 18.04+.

Usage

To get started right away with sensible defaults:

$ bento init && bento check

To set aside preexisting results so you only see issues in new code:

$ bento archive

Bento really sings when you run it automatically in your editor, as a commit hook (bento install-hook), or in CI.

Command Line Options

$ bento --help

Usage: bento [OPTIONS] COMMAND [ARGS]...

Options:
  --version  Show current Bento version.
  --agree    Automatically agree to terms of service.
  --help     Show this message and exit.

Commands:
  archive       Adds all current findings to the whitelist.
  check         Checks for new findings.
  disable       Disables a check.
  enable        Enables a check.
  init          Autodetects and installs tools.
  install-hook  Installs Bento as a git pre-commit hook.

Help and Community

  • Need help or want to share feedback? Reach out to us at support@r2c.dev. We’d love to hear from you! 💌
  • Join #bento in our community Slack for support, to talk with other users, and share feedback. 🤝
  • We’re shipping new Bento features all the time. Want to be first to know about what’s new? Sign up for the newsletter so you don’t miss out! We promise not to spam you, and you can unsubscribe at any time. 📫
  • We’re fortunate to benefit from the contributions of the open source community and great projects such as Bandit, ESLint, Flake8, and their plugins. 🙏
  • You’re also welcome to file an issue directly on GitHub. Or submit a feature request — we welcome those, too!

License and Legal

Please refer to the terms and privacy document.



r2c logo

Copyright (c) r2c.

About

Free program analysis focused on bugs that matter to you. 🍱

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors