
(Complete guide at Custom Release Channels)
In Plugins section press ⚙️ ( gear icon), select Manage Plugin Repositories. Open P圜harm / IntelliJ IDEA IDE settings. To receive this updates add EAP repository: EAP UpdatesĮarly builds of coming releases are available in EAP channel. Plugin is available in IntelliJ Plugins Repository, see SnakeCharm Plugin. code completion for directory, touch etc methods) please configure Python SDK with installed snakemake package. To enable all code insight features (e.g. Use *.zip bundle download from Plugin Manager or built from sources. Press gear icon and choose Install Plugin from Disk. In P圜harm (or other IntelliJ Platfrom based IDE with Python Community Edition plugin installed) open Preferences|Plugins|Marketplace|SnakeCharm and press Install button.įrom ZIP plugin bundle (alternative way): Otherwise, your custom file type will replace SnakeCharm support in snakemake files.
NB: If you’ve already configured custom file type for Snakefile or *.smk files please delete it ( or change file masks to smth else). Via JetBrains Plugins Market Place (recommended):
SnakeCharm in JetBrains Plugin Repository. Multiple code inspections for possible errors in snakemake files. Quick documentation for wrappers, that includes links to wrapper source code and paga in wrappers repository. Open rule declaration by name using Navigate|Symbol. Wrappers with detailed meta.yaml provides completion for rule section keyword arguments in output, input, params sections. Completion for wrappers names in wrapper: sections. Paths in sections: configfile, workdir, conda, include. Wildcards and sections names in shell, input, message, params and other sections. Rule sections keywords arguments, e.g. Rules sections names after rules.my_rule_name. Rules names after rules., checkpoints after checkpoints. Snakemake api methods like expand, temp, etc. Code completion and goto to declaration for:. Special highlighting for rule wildcards and their usages. Syntax highlighting for Snakemake string format language, e.g.
Snakemake framework should be configured to use python interpreter with snakemake module installed.įeatures available in Snakefile and *.smk, *.rule, *.rules files: NB: To activate all features please enable Snakemake support in Settings | Languages & Frameworks | Snakemake. Please report features suggestions or found bugs to project issue tracker. The plugin is developed by JetBrains Research Team, for more details see project home page. SnakeCharm plugin for P圜harm / IntelliJ Platform IDEs adds IDE support for Snakemake workflows language, that is widely used in Bioinformatics.