{"id":18039658,"url":"https://github.com/timbokz/rammy","last_synced_at":"2025-09-01T09:32:31.808Z","repository":{"id":65478992,"uuid":"131081400","full_name":"TimboKZ/Rammy","owner":"TimboKZ","description":"📝🛠️ Command line assistant for LaTeX projects","archived":false,"fork":false,"pushed_at":"2018-10-07T22:21:00.000Z","size":214,"stargazers_count":13,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-08-16T15:00:45.036Z","etag":null,"topics":["cli","es6","generator","javascript","latex","nodejs","rammy"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/rammy","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TimboKZ.png","metadata":{"files":{"readme":"README.md","changelog":"Changelog.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-04-26T01:08:26.000Z","updated_at":"2019-10-04T00:57:21.000Z","dependencies_parsed_at":"2023-01-25T08:15:25.458Z","dependency_job_id":null,"html_url":"https://github.com/TimboKZ/Rammy","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/TimboKZ/Rammy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TimboKZ%2FRammy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TimboKZ%2FRammy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TimboKZ%2FRammy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TimboKZ%2FRammy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TimboKZ","download_url":"https://codeload.github.com/TimboKZ/Rammy/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TimboKZ%2FRammy/sbom","scorecard":{"id":141839,"data":{"date":"2025-08-11","repo":{"name":"github.com/TimboKZ/Rammy","commit":"ea24e0a5a11eb323acb2f093069898fd8ed5edd9"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Vulnerabilities","score":0,"reason":"59 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-6chw-6frg-f759","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx","Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2","Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5","Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6","Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9","Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f","Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p","Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv","Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8","Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65","Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm","Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574","Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-h726-x36v-rx45","Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-g6ww-v8xp-vmwg","Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp","Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr","Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6","Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj","Warn: Project is vulnerable to: GHSA-3f95-r44v-8mrg","Warn: Project is vulnerable to: GHSA-28xr-mwxg-3qc8","Warn: Project is vulnerable to: GHSA-9p95-fxvg-qgq2","Warn: Project is vulnerable to: GHSA-9w5j-4mwv-2wj8","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-cf4h-3jhx-xvhq","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-16T08:19:45.529Z","repository_id":65478992,"created_at":"2025-08-16T08:19:45.529Z","updated_at":"2025-08-16T08:19:45.529Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273100058,"owners_count":25045697,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-01T02:00:09.058Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","es6","generator","javascript","latex","nodejs","rammy"],"created_at":"2024-10-30T14:09:59.351Z","updated_at":"2025-09-01T09:32:31.783Z","avatar_url":"https://github.com/TimboKZ.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ![Rammy](./assets/rammy-banner.png)\n\n[![npm](https://img.shields.io/npm/v/rammy.svg)](https://www.npmjs.com/package/rammy)\n[![npm](https://img.shields.io/npm/dt/rammy.svg)](https://www.npmjs.com/package/rammy)\n[![Build Status](https://travis-ci.org/TimboKZ/Rammy.svg?branch=master)](https://travis-ci.org/TimboKZ/Rammy)\n[![Build status](https://ci.appveyor.com/api/projects/status/5x1l205m023tfe5n/branch/master?svg=true)](https://ci.appveyor.com/project/TimboKZ/rammy/branch/master)\n![David](https://img.shields.io/david/TimboKZ/Rammy.svg)\n\n📝🛠️ Command line assistant and template manager for LaTeX projects.\n\nFeatures:\n* **LaTeX project setup** with Git support\n* **Rammy modules** with templates and useful LaTeX snippets\n* **TeX file generation** using templates from modules\n* **TeX compilation** supporting several TeX engines\n* **Directory cleaning** by removing auxiliary files\n\nDocumentation:\n* **README.md** (this file): General usage, command reference.\n* **[Modules.md](./Modules.md)**: Information about Rammy modules, example templates and snippets.\n* **[Changelog.md](./Changelog.md)**: Overview of changes in each version, including breaking changes.\n\n\u003e Rammy is still in active development - any feedback is welcome! If you encounter a bug, please [create an issue](https://github.com/TimboKZ/Rammy/issues) so it can be fixed.\n\u003e Development branch status:\n\u003e [![Build Status](https://travis-ci.org/TimboKZ/Rammy.svg?branch=dev)](https://travis-ci.org/TimboKZ/Rammy)\n\u003e [![Build status](https://ci.appveyor.com/api/projects/status/5x1l205m023tfe5n/branch/dev?svg=true)](https://ci.appveyor.com/project/TimboKZ/rammy/branch/dev)\n\n# Quick example\n\n```bash\n# Install Rammy\nnpm install -g rammy\n\n# Prepare a folder for the project\nmkdir my-project\ncd my-project\n\n# Initialise a Rammy project\nrammy init\n# Add `--git` flag to create a Git repo at the same time\n\n# Add a Rammy module, we'll use https://github.com/TimboKZ/latex-common\nrammy add TimboKZ/latex-common\n\n# List available modules, templates, snippets\nrammy list\n\n# Create a TeX file from `lecture-notes` template\nrammy create notes.tex lecture-notes\n\n# Compile the .tex file into a .pdf\nrammy compile notes.tex\n\n# Delete logs, .aux files, etc.\nrammy clean\n```\n\n# Installation\n\nFirst, install [Node.js v6+](https://nodejs.org/). Then run the following command:\n\n```bash\nnpm install -g rammy\n```\n\nThis will install Rammy globally and expose the `rammy` command in the terminal.\n\n# Commands\n\nYou can execute `rammy` or `rammy help \u003ccommand\u003e` in terminal for to view a brief overview of commands. This section has\na detailed description of each command.\n\n\n------------\n\n\n### Create a Rammy project\n\n```bash\nrammy init [directory] [--git]\n```\n\nCreates a Rammy project in the target directory. If no directory is specified, current directory is used. By default,\nonly creates a `.rammyrc.json` file.\n\nWhen `--git` flag is supplied, Rammy executes `git init` (if necessary) and appends [the contents of\n`TeX.gitignore`](./assets/TeX.gitignore) to `.gitignore`. `.gitignore` is created if it doesn't already exist. Using\nthis flag requires [Git](https://git-scm.com/) to be installed (for the `git` command).\n\n\n------------\n\n\n### Create a Rammy module\n\n```bash\nrammy init-module \u003cname\u003e [directory]\n```\n\nCreates a module `.rammyrc.json` in the specified directory. If no directory is specified, current directory is used.\nThe name should be command-line friendly, e.g. `latex-common`.\n\nYou only need to create a new Rammy module if you want to define some new templates or snippets.\n\n\n------------\n\n\n### Add a Rammy module\n\n```bash\nrammy add \u003cmodule\u003e\n```\n\nAdds a Rammy module to the current project. `\u003cmodule\u003e` can be one of the following:\n\n1. Shorthand for a GitHub repository, e.g. `TimboKZ/latex-common`.\n2. Valid Git URL, e.g. `git@github.com:TimboKZ/Rammy.git`. This doesn't have to be hosted on GitHub.\n3. Local path, e.g. `./path/to/module`. When using a local path, you must supply the `--path` flag.\n\nWhen using (1) or (2), Git logic might differ. If your Rammy project is inside a Git repository, the Rammy module folder\nwill be added as a Git submodule. If Rammy project is not inside a Git repository, the Rammy module will be simply\ncloned. The project is always cloned into the directory where `.rammyrc.json` is located. See [Modules.md](./Modules.md)\nfor more details on how modules work.\n\nIf you don't want to or can't use Git, you can just place the module folder anywhere on your hard disk and use (3).\n\n\n------------\n\n\n### List details of available modules\n\n```bash\nrammy list [--modules-only]\n```\n\nLists modules, templates and snippets discovered through the config. `--modules-only` or `-m` flag can be supplied to\nonly display module names.\n\n\n------------\n\n\n### Remove a module\n\n```bash\nrammy remove \u003cmodule-name\u003e\n```\n\nRemoves a module by its name. You can find out what modules are installed using `rammy list`. Doesn't actually remove\nthe module folder, just erases it from the config.\n\n\n------------\n\n\n### Create a TeX file from a template\n\n```bash\nrammy create \u003cfile\u003e \u003ctemplate\u003e\n```\n\nCreates a TeX file using the specified template. The template can either be a full template name (e.g.\n`latex-common/lecture-notes`), short template name (e.g. `lecture-notes`) or a path to a tex file (e.g. `\n./path/to/template.tex`).\n\n\n------------\n\n\n### Add a snippet to existing TeX file\n\n```bash\nrammy extend \u003cfile\u003e \u003csnippet\u003e\n```\n\nAdds a TeX snippet to an existing `.tex` file. Specified snippet name can either be a snippet name or a path to another\n`.tex` file. Snippets are added through `\\input{...}` commands - see [Modules.md](./Modules.md) for more details on how\nsnippets work.\n\n\n------------\n\n\n### Compile a TeX file into a PDF\n\n```bash\nrammy compile \u003cfile\u003e [--clean]\n```\n\nCompiles a TeX file using either `pdflatex` or `latexmk`, depending on what is available. If none of these are\navailable, the command will fail.\n\n`--clean` or `-c` flag can be supplied to delete auxiliary files afterwards. This is equivalent to running `rammy\ncompile \u003cfile\u003e` followed by `rammy clean \u003cfile\u003e`.\n\n\n------------\n\n\n### Cleaning auxiliary files\n\n```bash\nrammy clean [file]\n```\n\nCleans the current working directory or the specified TeX file. If a TeX file is specified, e.g.\n`rammy clean ./folder/doc.tex`, Rammy will scan the folder containing the TeX file and delete *relevant* `.aux`,\n`.fdb_latexmk`, `.fls`, `.log`, `.out` and others. *Relevant* means files that share the same basename, e.g. `doc.aux`.\n\n\n------------\n\n\n# Contributing\n\nRammy is still in experimental phase so contributing at this stage is not recommended. You can [create an issue](https://github.com/TimboKZ/Rammy/issues) to start a discussion.\n\nIf you end up adding something, make sure `npm test` and `npm run lint` terminate without any errors before creating a\npull request.\n\n\n# Notes about Rammy\n\nSome planned features:\n* `rammy fix \u003cfile\u003e` command: If you move a generated `.tex` file around, relative paths might break. Rammy can fix most (if not all) of these paths thanks to metadata in comments. This command will do exactly that.\n* Add redundancy checks to `rammy extend`: if a snippet is already a part of the file, Rammy will not import it again.\n* Support more engines for `rammy compile`, make `rammy clean` more intelligent.\n\nI wrote Rammy during my time at [Caltech](http://www.caltech.edu/), so I can't help but include this:\n\n![CalTeX](./assets/caltex.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimbokz%2Frammy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimbokz%2Frammy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimbokz%2Frammy/lists"}