trapline 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4512a1d91ced4516d053f35a63b9c3e421e13445a047bd6204890e1b28094dcf
-  data.tar.gz: 63389b3d583eea89f84dcb04ce2fedf502ee5c917d9eb363b455237b3a117ba5
+  metadata.gz: 7fdc8ed7dd098d60e8f4bfa89f9cf9df427c42a783cee43534888f7a9dd8b752
+  data.tar.gz: ed7d1ba3a99cf576e116ee476a0ee3d0b8ed31d0ba3405d8222f37b814713e8b
 SHA512:
-  metadata.gz: 52530cb305ad1f19e1740f7265b80fbd0345031cad2f4f033bf28908d122c272b04e1ea2279895a11a07b23ec776aa683787126f3199bb41ceb3f50e36dc22ed
-  data.tar.gz: 67d866ff50f4d6fd28da3568322f34bb46928c95216f691257753e19a244a15544cbef9eddabfeb2791eeba4f2dcbc61c33896c9c6d48709f1fd33799ecfa949
+  metadata.gz: b13b080b1d97c92f110d3ee32be22b77078646f92f99805aa198409b33922fefabf658b4c6e69005163e1630397135abb32a5b598f2fd805764f9b51fce82352
+  data.tar.gz: e91f788c8e736f70da61cfd6737f8f672743e83129a77ba3c2149af9acf9f74c7c00cade672f44d5b05e11ddae63b287b575c959095ce4c223ddbc7e72d15744

data/README.md

@@ -86,7 +86,7 @@ pip install semgrep      # or: brew install semgrep
 
 ```bash
 trapline version
-# trapline 0.1.0
+# trapline 0.1.1
 # engine: opengrep 1.33.1 (/Users/you/.opengrep/cli/latest/opengrep)
 ```
 

data/lib/trapline/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Trapline
-  VERSION = "0.1.0"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trapline
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Jose Augusto
@@ -45,10 +45,52 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 description: |
-  Trapline is a web editor for creating, testing and maintaining semgrep/opengrep
-  rules, with structural validation, execution with ruleid/ok annotations and a
-  draft generator from CVEs (NVD + OSV) with per-CWE templates. It works as a
-  CLI (`trapline server`), as a Rack app and mounted in a Rails app.
+  Trapline is a web editor and CLI for writing and testing opengrep/semgrep
+  rules, plus a generator that turns a CVE into rule drafts with test code.
+  Test files stay in the standard --test format.
+
+  INSTALL
+
+    gem install trapline
+
+  Trapline needs an engine on your PATH, opengrep (recommended) or semgrep:
+
+    curl -fsSL https://raw.githubusercontent.com/opengrep/opengrep/main/install.sh | bash
+    pip install semgrep
+
+  The opengrep installer puts the binary in ~/.opengrep/cli/latest/. Add it to
+  your PATH or pass --engine-bin. Check the setup with:
+
+    trapline version
+
+  USAGE
+
+  Web editor (http://127.0.0.1:9292):
+
+    trapline server -r ./rules
+
+  Write the rule, paste vulnerable and fixed code, and click the margin to mark
+  the lines that must or must not match. Trapline writes the ruleid/ok
+  annotations and reruns as you type.
+
+  Rule drafts from a CVE or GHSA (looked up in NVD and OSV):
+
+    trapline cve CVE-2024-4577                           # list the drafts
+    trapline cve CVE-2024-4577 --save --pick 2 -r ./rules
+
+  Validate and test rules (exits 1 on failure, for CI):
+
+    trapline validate --engine rules/*.yaml
+    trapline test -r ./rules
+    trapline run rules/my-rule.yaml app/models/user.rb
+
+  Rails: add gem "trapline" to the Gemfile, then
+
+    bin/rails generate trapline:install    # editor at /trapline
+    bin/rails trapline:test
+
+  It also runs as a Rack app (run Trapline::Web::App.new in config.ru). No
+  runtime dependencies besides Ruby 3.3+ and the engine binary.
 email:
 - joseaugusto.881@outlook.com
 executables:
@@ -131,6 +173,6 @@ requirements:
 rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: Editor and generator for semgrep/opengrep rules, standalone or mounted in
-  Rails
+summary: 'Write, test and generate opengrep/semgrep rules: web editor, CLI and CVE-to-rule
+  drafts'
 test_files: []