seqera 0.4.0-dev.d01780d → 0.5.0-dev.0fbe3ec

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +321 -0
  2. package/package.json +7 -6
package/README.md ADDED
@@ -0,0 +1,321 @@
1
+ # Seqera AI CLI
2
+
3
+ AI-powered assistant for bioinformatics workflows and [Seqera Platform](https://seqera.io).
4
+
5
+ ## Get started
6
+
7
+ 1. Install the Seqera AI CLI:
8
+
9
+ ```bash
10
+ npm install -g seqera
11
+ ```
12
+
13
+ See [Installation](https://docs.seqera.io/platform-cloud/seqera-ai/installation) for a comprehensive installation guide.
14
+
15
+ 2. Log in to your Seqera account:
16
+
17
+ ```bash
18
+ seqera login
19
+ ```
20
+
21
+ See [Authentication](https://docs.seqera.io/platform-cloud/seqera-ai/authentication) for a comprehensive authentication guide.
22
+
23
+ 3. Start Seqera AI:
24
+
25
+ ```bash
26
+ seqera ai
27
+ ```
28
+
29
+ 4. Run your first prompt:
30
+
31
+ ```
32
+ List my recent workflows
33
+ ```
34
+
35
+ See [Use cases](https://docs.seqera.io/platform-cloud/seqera-ai/use-cases) for a comprehensive list of use cases.
36
+
37
+ ## Use cases
38
+
39
+ Seqera AI is an intelligent command-line assistant that helps you build, run, and manage bioinformatics workflows. The following sections describe several common use cases.
40
+
41
+ ### Work with Nextflow
42
+
43
+ Seqera AI helps you develop, debug, and understand Nextflow pipelines with AI-powered analysis and code generation.
44
+
45
+ <details open>
46
+ <summary><strong>Working with Nextflow</strong></summary>
47
+
48
+ **Understand your pipeline structure**:
49
+
50
+ ```
51
+ > Show me the structure of main.nf
52
+ ```
53
+
54
+ ```
55
+ > What processes are defined in this pipeline?
56
+ ```
57
+
58
+ **Generate a `nextflow.config` file**:
59
+
60
+ ```
61
+ > Generate a nextflow.config for my pipeline
62
+ ```
63
+
64
+ **Debug your pipeline**:
65
+
66
+ ```
67
+ > Why is my pipeline failing?
68
+ ```
69
+
70
+ ```
71
+ > Run nextflow lint on my pipeline
72
+ ```
73
+
74
+ **Generate a schema (`nextflow_schema.json`) file**:
75
+
76
+ ```
77
+ > Generate a nextflow_schema.json for my pipeline
78
+ ```
79
+
80
+ **Convert scripts to Nextflow**:
81
+
82
+ ```
83
+ > Convert my Python script to a Nextflow process
84
+ ```
85
+
86
+ </details>
87
+
88
+ ### Build containers with Wave
89
+
90
+ Seqera AI can create containerized environments using Wave, without requiring you to write Dockerfiles.
91
+
92
+ <details open>
93
+ <summary><strong>Building containers with Wave</strong></summary>
94
+
95
+ **Create a container with conda packages**:
96
+
97
+ ```
98
+ > Create a container with samtools and bwa from bioconda
99
+ ```
100
+
101
+ **Create a container with pip packages**:
102
+
103
+ ```
104
+ > Build a container with pandas, numpy, and scikit-learn
105
+ ```
106
+
107
+ **Get a container for a specific tool**:
108
+
109
+ ```
110
+ > I need a container with FastQC version 0.12.1
111
+ ```
112
+
113
+ > **Note:** The assistant will generate a Wave container URL that you can use directly in your Nextflow pipelines or pull with Docker.
114
+
115
+ </details>
116
+
117
+ ### Customize your session
118
+
119
+ Customize your session with command-line options.
120
+
121
+ <details open>
122
+ <summary><strong>Customize your session</strong></summary>
123
+
124
+ **Start in a specific directory**:
125
+
126
+ ```bash
127
+ seqera ai -w /path/to/project
128
+ ```
129
+
130
+ **Set approval mode for local commands**:
131
+
132
+ ```bash
133
+ seqera ai -a full
134
+ ```
135
+
136
+ </details>
137
+
138
+ ### Exit the assistant
139
+
140
+ End your Seqera AI session when done.
141
+
142
+ <details open>
143
+ <summary><strong>Exit the assistant</strong></summary>
144
+
145
+ **To end your session**:
146
+
147
+ - Type `/exit` or `/quit`
148
+ - Press `Ctrl+C`
149
+
150
+ > **Note:** Your conversation history is preserved for the session but not stored permanently.
151
+
152
+ </details>
153
+
154
+ ### Use slash commands
155
+
156
+ Seqera AI includes built-in slash commands for common workflows.
157
+
158
+ <details open>
159
+ <summary><strong>Use slash commands</strong></summary>
160
+
161
+ **Type `/` to see all available commands**:
162
+
163
+ | Command | Description |
164
+ |---------|-------------|
165
+ | `/help` (or `?`) | Show available commands |
166
+ | `/exit` (`/quit`, `/q`) | Exit the application |
167
+ | `/clear` | Clear conversation history |
168
+ | `/thinking` | Toggle thinking display |
169
+ | `/scroll` | Toggle auto-scroll |
170
+ | `/org` | Show current organization |
171
+ | `/session` | Show current session ID |
172
+ | `/sessions` | Browse and switch sessions |
173
+ | `/lsp` | Show LSP server status |
174
+ | `/status` | Show system status |
175
+ | `/credits` | Show credit balance and usage |
176
+ | `/approval [mode]` | Show or set approval mode (`always`/`default`/`suggest`) |
177
+ | `/update` | Check CLI updates and next steps |
178
+ | `/feedback` | Open feedback form |
179
+ | `/help-community` | Open community help |
180
+ | `/stickers` | Get Seqera stickers |
181
+
182
+ </details>
183
+
184
+ ### Work with data
185
+
186
+ Seqera AI helps you manage data through Platform data links and access reference datasets.
187
+
188
+ <details open>
189
+ <summary><strong>Working with data</strong></summary>
190
+
191
+ **Browse data links**:
192
+
193
+ ```
194
+ > List my data links
195
+ ```
196
+
197
+ ```
198
+ > Show me the contents of my S3 data link
199
+ ```
200
+
201
+ **Download and upload files**:
202
+
203
+ ```
204
+ > Generate a download URL for results/final_report.html
205
+ ```
206
+
207
+ ```
208
+ > Upload my local results to the data link
209
+ ```
210
+
211
+ **Access reference data**:
212
+
213
+ ```
214
+ > Find the human reference genome GRCh38
215
+ ```
216
+
217
+ ```
218
+ > Search for RNA-Seq test data
219
+ ```
220
+
221
+ </details>
222
+
223
+ ### Work with local files
224
+
225
+ Seqera AI can interact with files in your current working directory.
226
+
227
+ <details open>
228
+ <summary><strong>Work with local files</strong></summary>
229
+
230
+ **Start the assistant from your project folder**:
231
+
232
+ ```bash
233
+ cd /path/to/your/project
234
+ seqera ai
235
+ ```
236
+
237
+ **Then, ask the assistant to help with local tasks**:
238
+
239
+ ```
240
+ > Show me the structure of main.nf
241
+ ```
242
+
243
+ ```
244
+ > Add a new process to handle quality control
245
+ ```
246
+
247
+ > **Note:** Local file operations are controlled by [approval modes](https://docs.seqera.io/platform-cloud/seqera-ai/command-approval). By default, the assistant will ask for your approval before making changes outside your working directory or running potentially dangerous commands.
248
+
249
+ </details>
250
+
251
+ ### Work with nf-core modules
252
+
253
+ Seqera AI provides access to over 1,000 nf-core modules for common bioinformatics tasks.
254
+
255
+ <details open>
256
+ <summary><strong>Working with nf-core modules</strong></summary>
257
+
258
+ **Search for modules**:
259
+
260
+ ```
261
+ > Find nf-core modules for sequence alignment
262
+ ```
263
+
264
+ ```
265
+ > What modules are available for variant calling?
266
+ ```
267
+
268
+ **Get module details**:
269
+
270
+ ```
271
+ > Show me how to use the nf-core/bwa/mem module
272
+ ```
273
+
274
+ **Run a module**:
275
+
276
+ ```
277
+ > Run FastQC on my FASTQ files
278
+ ```
279
+
280
+ > **Note:** The assistant can generate the exact Nextflow command with proper parameters for your data.
281
+
282
+ </details>
283
+
284
+ ### Work with Seqera Platform
285
+
286
+ Use Seqera Platform capabilities to run and manage workflows at scale with AI assistance.
287
+
288
+ <details open>
289
+ <summary><strong>Working with Seqera Platform</strong></summary>
290
+
291
+ **List your workflows**:
292
+
293
+ ```
294
+ > List my recent workflows
295
+ ```
296
+
297
+ **Launch a pipeline**:
298
+
299
+ ```
300
+ > Launch the nf-core/rnaseq pipeline with the test profile
301
+ ```
302
+
303
+ **Debug failed runs**:
304
+
305
+ ```
306
+ > Why did my last workflow fail?
307
+ ```
308
+
309
+ ```
310
+ > Get the logs for the failed task in my last run
311
+ ```
312
+
313
+ </details>
314
+
315
+ ## Learn more
316
+
317
+ - [Installation](https://docs.seqera.io/platform-cloud/seqera-ai/installation): Detailed installation instructions
318
+ - [Authentication](https://docs.seqera.io/platform-cloud/seqera-ai/authentication): Log in, log out, and session management
319
+ - [Command approval](https://docs.seqera.io/platform-cloud/seqera-ai/command-approval): Control which commands run automatically
320
+ - [Use cases](https://docs.seqera.io/platform-cloud/seqera-ai/use-cases): Seqera AI CLI use cases
321
+ - [Troubleshooting](https://docs.seqera.io/platform-cloud/troubleshooting_and_faqs/seqera-ai): Troubleshoot common errors
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "seqera",
3
- "version": "0.4.0-dev.d01780d",
3
+ "version": "0.5.0-dev.0fbe3ec",
4
4
  "description": "AI-powered CLI for Seqera Platform - bioinformatics workflow management",
5
5
  "keywords": [
6
6
  "seqera",
@@ -11,17 +11,18 @@
11
11
  "cli"
12
12
  ],
13
13
  "author": "Seqera Labs",
14
- "license": "Apache-2.0",
14
+ "license": "Custom",
15
15
  "bin": {
16
16
  "seqera": "bin/seqera"
17
17
  },
18
18
  "files": [
19
- "bin/**"
19
+ "bin/**",
20
+ "README.md"
20
21
  ],
21
22
  "optionalDependencies": {
22
- "@seqera/cli-darwin-arm64": "0.4.0-dev.d01780d",
23
- "@seqera/cli-darwin-x64": "0.4.0-dev.d01780d",
24
- "@seqera/cli-linux-x64": "0.4.0-dev.d01780d"
23
+ "@seqera/cli-darwin-arm64": "0.5.0-dev.0fbe3ec",
24
+ "@seqera/cli-darwin-x64": "0.5.0-dev.0fbe3ec",
25
+ "@seqera/cli-linux-x64": "0.5.0-dev.0fbe3ec"
25
26
  },
26
27
  "engines": {
27
28
  "node": ">=18"