diff --git a/platform-cloud/cloud-sidebar.json b/platform-cloud/cloud-sidebar.json index 126a2a069..98a50ba0b 100644 --- a/platform-cloud/cloud-sidebar.json +++ b/platform-cloud/cloud-sidebar.json @@ -158,6 +158,19 @@ "administration/credit-management" ] }, + { + "type": "category", + "label": "Seqera AI CLI", + "link": {"type": "doc", "id": "seqera-ai/index"}, + "collapsed": true, + "items": [ + "seqera-ai/get-started", + "seqera-ai/installation", + "seqera-ai/authentication", + "seqera-ai/command-approval", + "seqera-ai/use-cases" + ] + }, { "type": "category", "label": "Developer tools", @@ -221,7 +234,8 @@ "troubleshooting_and_faqs/azure_troubleshooting", "troubleshooting_and_faqs/workspaces_troubleshooting", "troubleshooting_and_faqs/resource-labels", - "troubleshooting_and_faqs/datasets_troubleshooting" + "troubleshooting_and_faqs/datasets_troubleshooting", + "troubleshooting_and_faqs/seqera-ai" ] } ] diff --git a/platform-cloud/docs/seqera-ai/authentication.md b/platform-cloud/docs/seqera-ai/authentication.md new file mode 100644 index 000000000..79a447a55 --- /dev/null +++ b/platform-cloud/docs/seqera-ai/authentication.md @@ -0,0 +1,128 @@ +--- +title: "Authentication" +description: "Login, logout, and session management for Seqera AI CLI" +date: "15 Dec 2025" +tags: [seqera-ai, cli, authentication, login] +--- + +:::caution Seqera AI CLI is in beta +Seqera AI CLI is currently in beta. Features and commands may change as we continue to improve the product. +::: + +:::note +Seqera Cloud users receive $20 in free credits to get started with Seqera AI. [Contact us](https://seqera.io/platform/seqera-ai/request-credits/) for additional credits. +::: + +Seqera AI uses your Seqera Platform account for authentication. This page describes authentication concepts and step-by-step instructions for managing your sessions. + +## Credential storage + +Seqera AI stores authentication tokens securely in your operating system's secure keychain: + +- **macOS**: Keychain Access +- **Linux**: Secret Service (GNOME Keyring, KWallet) +- **Windows**: Windows Credential Manager + +If keychain access isn't available, tokens are stored in: + +``` +~/.config/seqera-ai/refresh-token. +``` + +Session metadata (e.g., email, login timestamp) is stored in: + +``` +~/.config/seqera-ai/auth-state.json +``` + +## Token refresh + +Seqera AI CLI automatically refreshes your authentication token when needed. You are not required to log in again unless: + +- You explicitly log out +- Your refresh token expires (typically after extended inactivity) +- Your Seqera Platform account permissions change + +## Authenticating Seqera AI + +### Log in + +To authenticate with your Seqera Platform account, run: + +```bash +seqera login +``` + +This will: + +1. Open your default browser to the Seqera login page +1. Prompt you to sign in with your Seqera Platform credentials +1. Automatically capture the authentication token +1. Display a success message in your terminal + + ``` + Opening browser for authentication... + Successfully authenticated as user@example.com + ``` + +### View session status + +To view your current authentication status, run: + +```bash +seqera status +``` + +You should see output similar to: + +```console +Logged in as: user@example.com +Session expires: 2025-12-16 14:30:00 +``` + +### Add access tokens for automation + +For automated environments, you can provide a Seqera Platform access token directly: + +```bash +seqera ai --token +``` + +You can also set the token via environment variable: + +```bash +export TOWER_ACCESS_TOKEN= +seqera ai +``` + +This shows your login status, authenticated email, and session details. + +### Log out + +#### Standard logout + +To sign out from the current session, run: + +```bash +seqera logout +``` + +This command revokes your current authentication token and removes locally stored credentials. You will need to re-authenticate on next use. + +#### Clear all sessions + +To remove all profiles and completely reset authentication, run: + +```bash +seqera logout --all +``` + +This command removes all stored credentials and session data. + +## Learn more + +- [Seqera AI CLI](index.md): Seqera AI CLI overview +- [Installation](./installation.md): Detailed installation instructions +- [Command approval](./command-approval.md): Control which commands run automatically +- [Use cases](./use-cases.md): Seqera AI use cases +- [Troubleshooting](../troubleshooting_and_faqs/seqera-ai.md): Troubleshoot common errors diff --git a/platform-cloud/docs/seqera-ai/command-approval.md b/platform-cloud/docs/seqera-ai/command-approval.md new file mode 100644 index 000000000..caa55f2b1 --- /dev/null +++ b/platform-cloud/docs/seqera-ai/command-approval.md @@ -0,0 +1,215 @@ +--- +title: "Command approval" +description: "Control which local commands require user approval in Seqera AI" +date: "15 Dec 2025" +tags: [seqera-ai, cli, approval, security] +--- + +:::caution Seqera AI CLI is in beta +Seqera AI CLI is currently in beta. Features and commands may change as we continue to improve the product. +::: + +:::note +Seqera Cloud users receive $20 in free credits to get started with Seqera AI. [Contact us](https://seqera.io/platform/seqera-ai/request-credits/) for additional credits. +::: + +Seqera AI can execute local commands and edit files in your environment. This page explains approval modes that control which operations run automatically versus which require your permission, including dangerous commands, workspace boundaries, and best practices. + +## Approval prompts + +When a command requires approval, you will see output similar to: + +``` +The assistant wants to run: + rm -rf ./build/ + +[A]pprove [R]eject [E]dit +``` + +You can: + +- **Approve (A)**: Run the command as shown +- **Reject (R)**: Cancel the command +- **Edit (E)**: Modify the command before running + +## Approval modes + +Approval modes control which local commands Seqera AI can execute automatically and which require your explicit approval. This provides a balance between convenience and safety when working with local files and commands. + +There are three approval modes: + +| Mode | Description | Best for | +|------|-------------|----------| +| **basic** | Only safe, read-only commands run automatically | Maximum security | +| **default** | Safe commands and workspace file edits run automatically | Typical development | +| **full** | Everything except dangerous commands runs automatically | Experienced users | + +### Basic + +**Rule**: Only safe, read-only commands run automatically. Everything else requires approval. + +This is the most restrictive mode. The assistant can only auto-execute commands that view information without making changes. + +**Auto-executes**: + +- `cat` - View file contents +- `ls` - List directory contents +- `pwd` - Show current directory +- `head` - View file beginning +- `tail` - View file end +- `tree` - Display directory tree +- `echo` - Print text (without file redirection) +- `date` - Show current date/time +- `whoami` - Show current user +- `env` - Display environment variables +- `printenv` - Print environment variables +- `stat` - Show file status +- `uptime` - Show system uptime + +**Requires approval**: All other commands, including file edits, directory creation, and any other command execution. Safe commands that include file redirections (e.g., `echo "hello" > file.txt`) also require approval. + +**Use when**: You want maximum control and visibility over every action the assistant takes. + +**Examples**: + +``` +> Create a new file called test.txt with "hello world" + +The assistant wants to create file: + ./test.txt + +[A]pprove [R]eject [E]dit +``` + +### Default + +**Rule**: Safe commands and file operations within your workspace run automatically. All other commands require approval. + +This is the recommended mode for most users. It allows productive workflow while protecting system files and preventing destructive operations. + +**Auto-executes**: +- All safe commands from basic mode (without file redirections) +- File edits **within your current workspace**: + - Creating files (`touch`, file creation) + - Editing files (text modifications) + - Creating directories (`mkdir`) + - Copying files (`cp` within workspace) + - Moving files (`mv` within workspace) + +**Requires approval**: +- File operations **outside your workspace** +- All dangerous commands (see below) +- Commands with file redirects to paths outside workspace +- All other commands (e.g., `curl`, `wget`, `git`, `npm`, `python`, etc.) + +**Use when**: You're doing typical development work and want convenience without compromising safety. + +**Examples**: + +``` +> Create a new file called test.txt with "hello world" + +Created ./test.txt +``` + +File creation in the workspace runs automatically. + +``` +> Edit /etc/hosts + +The assistant wants to edit file: + /etc/hosts + +[A]pprove [R]eject [E]dit +``` + +Editing outside the workspace requires approval. + + +### Full + +**Rule**: Everything runs automatically except explicitly dangerous commands. + +This is the most permissive mode. Use it when you fully trust the assistant's actions and want minimal interruption. + +**Auto-executes**: All commands except those on the dangerous list. + +**Requires approval**: Only dangerous commands (see below). + +**Use when**: You're an experienced user comfortable with automated command execution, or when working in an isolated/disposable environment. + +## Dangerous commands + +These commands **always require approval** in any mode: + +| Command | Risk | +|---------|------| +| `rm` | Delete files/directories | +| `chmod` | Change file permissions | +| `chown` | Change file ownership | +| `kill` | Terminate processes | +| `killall` | Terminate multiple processes | +| `pkill` | Kill processes by name | +| `sudo` | Execute as superuser | +| `dd` | Low-level data operations | +| `mount` | Mount filesystems | +| `umount` | Unmount filesystems | +| `mkfs` | Create filesystems | +| `reboot` | Restart system | +| `shutdown` | Power off system | + +**Examples**: + +``` +> Create files and directories as needed + +Created ./src/utils.py +Created ./tests/test_utils.py +Created ./config/settings.json +``` + +Most operations run without prompts. + +``` +> Delete the build directory + +The assistant wants to run: + rm -rf ./build/ + +[A]pprove [R]eject [E]dit +``` + +Dangerous commands still require approval. + +## Workspace boundaries + +In **default** mode, the "workspace" is your current working directory and its subdirectories. File operations are evaluated as: + +- **Inside workspace**: `/path/to/workspace/src/file.txt` - auto-executes +- **Outside workspace**: `/etc/config` or `~/other-project/file.txt` - requires approval + +The workspace is set when you start the assistant: + +```bash +# Workspace is /home/user/my-project +cd /home/user/my-project +seqera ai + +# Or explicitly set the workspace +seqera ai -w /home/user/my-project +``` + +## Best practices + +- **Start with default mode**: It provides a good balance for most workflows +- **Use basic mode for unfamiliar projects**: When exploring new codebases +- **Reserve full mode for trusted contexts**: Disposable environments or well-understood tasks +- **Review dangerous command prompts carefully**: These commands can have significant impact + +## Learn more + +- [Seqera AI CLI](index.md): Seqera AI CLI overview +- [Installation](./installation): Detailed installation instructions +- [Authentication](./authentication): Log in, log out, and session management +- [Use cases](./use-cases.md): Seqera AI use cases +- [Troubleshooting](../troubleshooting_and_faqs/seqera-ai.md): Troubleshoot common errors diff --git a/platform-cloud/docs/seqera-ai/get-started.md b/platform-cloud/docs/seqera-ai/get-started.md new file mode 100644 index 000000000..ac64b29f7 --- /dev/null +++ b/platform-cloud/docs/seqera-ai/get-started.md @@ -0,0 +1,57 @@ +--- +title: "Get started" +description: "AI-powered assistant for bioinformatics workflows and Seqera Platform" +date: "2025-12-16" +tags: [seqera-ai, cli, ai] +--- + +:::caution Seqera AI CLI is in beta +Seqera AI CLI is currently in beta. Features and commands may change as we continue to improve the product. +::: + +:::note +Seqera Cloud users receive $20 in free credits to get started with Seqera AI. [Contact us](https://seqera.io/platform/seqera-ai/request-credits/) for additional credits. +::: + +## Get started + +To get started with Seqera AI: + +1. Install the Seqera AI CLI: + + ```bash + pip install seqera-ai + ``` + + See [Installation](./installation.md) for a comprehensive installation guide. + +1. Log in to your Seqera account: + + ```bash + seqera login + ``` + + See [Authentication](./authentication.md) for a comprehensive authentication guide. + + +1. Start Seqera AI: + + ```bash + seqera ai + ``` + +1. Run your first prompt: + + ``` + /debug + ``` + + See [Use cases](./use-cases.md) for a comprehensive list of use cases. + +## Learn more + +- [Installation](./installation.md): Detailed installation instructions +- [Authentication](./authentication.md): Log in, log out, and session management +- [Command approval](./command-approval.md): Control which commands run automatically +- [Use cases](./use-cases.md): Seqera AI CLI use cases +- [Troubleshooting](../troubleshooting_and_faqs/seqera-ai.md): Troubleshoot common errors diff --git a/platform-cloud/docs/seqera-ai/index.md b/platform-cloud/docs/seqera-ai/index.md new file mode 100644 index 000000000..f1c402ada --- /dev/null +++ b/platform-cloud/docs/seqera-ai/index.md @@ -0,0 +1,99 @@ +--- +title: "Seqera AI CLI" +description: "AI-powered assistant for bioinformatics workflows and Seqera Platform" +date: "2025-12-15" +tags: [seqera-ai, cli, ai] +--- + +:::caution Seqera AI CLI is in beta +Seqera AI CLI is currently in beta. Features and commands may change as we continue to improve the product. +::: + +:::note +Seqera Cloud users receive $20 in free credits to get started with Seqera AI. [Contact us](https://seqera.io/platform/seqera-ai/request-credits/) for additional credits. +::: + +Seqera AI CLI is an intelligent command-line assistant that helps you build, run, and manage bioinformatics workflows. Powered by advanced AI, it provides an interactive terminal experience for working with Nextflow pipelines and Seqera Platform. + +Seqera AI has access to: + +- **Your Seqera Platform workspace**: View and manage workflows, pipelines, and data through your authenticated account +- **Your local environment**: Execute commands and edit files in your working directory (with configurable approval controls) +- **AI capabilities**: Natural language understanding, code generation, and intelligent suggestions + +## Seqera AI features + +### Natural language interface + +Interact with Seqera Platform using plain English. Ask questions, launch workflows, and manage pipelines through conversational commands. + +### Workflow management + +Launch, monitor, and debug Nextflow workflows directly from your terminal. Get real-time status updates, view logs, and analyze run metrics. + +### Pipeline development + +Generate Nextflow configurations, create pipeline schemas, and convert scripts from other workflow languages (WDL, Snakemake) to Nextflow. + +### nf-core integration + +Search and discover nf-core modules, get detailed execution information, and access ready-to-run Nextflow commands for over 1,000 standardized bioinformatics tools. + +### Data management + +Browse cloud storage through data links, manage datasets, generate download and upload URLs, and access reference genomes and sequencing data. + +### Wave containers + +Build containerized environments on-the-fly with conda packages, pip packages, or custom Docker images. Create reproducible containers for your bioinformatics tools without writing Dockerfiles. + +### Local file operations + +Edit files, run commands, and manage your local development environment with AI assistance and configurable approval modes. + +### Seqera Platform integration + +Full access to Platform capabilities including compute environments, datasets, data links, and workspace management. + +## Get started + +To get started with Seqera AI: + +1. Install the Seqera AI CLI: + + ```bash + pip install seqera-ai + ``` + + See [Installation](./installation.md) for a comprehensive installation guide. + +1. Log in to your Seqera account: + + ```bash + seqera login + ``` + + See [Authentication](./authentication.md) for a comprehensive authentication guide. + + +1. Start Seqera AI: + + ```bash + seqera ai + ``` + +1. Run your first prompt: + + ``` + /debug + ``` + + See [Use cases](./use-cases.md) for a comprehensive list of use cases. + +## Learn more + +- [Installation](./installation.md): Detailed installation instructions +- [Authentication](./authentication.md): Log in, log out, and session management +- [Command approval](./command-approval.md): Control which commands run automatically +- [Use cases](./use-cases.md): Seqera AI CLI use cases +- [Troubleshooting](../troubleshooting_and_faqs/seqera-ai.md): Troubleshoot common errors diff --git a/platform-cloud/docs/seqera-ai/installation.md b/platform-cloud/docs/seqera-ai/installation.md new file mode 100644 index 000000000..1abca2a6f --- /dev/null +++ b/platform-cloud/docs/seqera-ai/installation.md @@ -0,0 +1,91 @@ +--- +title: "Installation" +description: "Install and configure Seqera AI CLI" +date: "15 Dec 2025" +tags: [seqera-ai, cli, installation] +--- + +:::caution Seqera AI CLI is in beta +Seqera AI CLI is currently in beta. Features and commands may change as we continue to improve the product. +::: + +:::note +Seqera Cloud users receive $20 in free credits to get started with Seqera AI. [Contact us](https://seqera.io/platform/seqera-ai/request-credits/) for additional credits. +::: + +## Requirements + +- Python 3.13 or later +- macOS, Linux, or Windows with WSL +- A Seqera Platform account ([sign up for free](https://cloud.seqera.io)) +- An internet connection + +## Python Package Index + +The Seqera AI CLI is distributed as a Python package through PyPI, making installation simple and straightforward using standard Python tools. + +### Install + +To install Seqera AI CLI from Python Package Index (PyPI): + +1. Check your Python version: + + ```bash + python --version + # or + python3 --version + ``` + + If you need to install or upgrade Python, see [python.org](https://www.python.org/downloads/) or use your system's package manager. + + +1. Install Seqera AI CLI: + + ```bash + pip install seqera-ai + ``` + + :::tip + Consider using a virtual environment to avoid conflicts with other Python packages: + ```bash + python -m venv seqera-env + source seqera-env/bin/activate # On Windows: seqera-env\Scripts\activate + pip install seqera-ai + ``` + ::: + +1. Verify your installation: + + ```bash + seqera --version + ``` + + You will see output similar to: + + ```console + seqera-ai 0.1.0 + ``` + +### Upgrade + +To upgrade your version of Seqera AI CLI, run: + +```bash +pip install --upgrade seqera-ai +``` + +### Uninstall + +To uninstall your version of Seqera AI CLI, run: + +```bash +pip uninstall seqera-ai +``` + +## Learn more + +- [Seqera AI CLI](index.md): Seqera AI CLI overview +- [Authentication](./authentication.md): Login, logout, and session management +- [Command approval](./command-approval.md): Control which commands run automatically +- [Use cases](./use-cases.md): Seqera AI CLI use cases +- [Troubleshooting](../troubleshooting_and_faqs/seqera-ai.md): Troubleshoot common errors diff --git a/platform-cloud/docs/seqera-ai/use-cases.md b/platform-cloud/docs/seqera-ai/use-cases.md new file mode 100644 index 000000000..1f401f2da --- /dev/null +++ b/platform-cloud/docs/seqera-ai/use-cases.md @@ -0,0 +1,302 @@ +--- +title: "Use cases" +description: "Learn how to use Seqera AI CLI for bioinformatics workflows, pipeline development, and data management" +date: "2025-12-15" +tags: [seqera-ai, cli, ai, use cases] +--- + +:::caution Seqera AI CLI is in beta +Seqera AI CLI is currently in beta. Features and commands may change as we continue to improve the product. +::: + +:::note +Seqera Cloud users receive $20 in free credits to get started with Seqera AI. [Contact us](https://seqera.io/platform/seqera-ai/request-credits/) for additional credits. +::: + +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. + +## Work with Nextflow + +Seqera AI helps you develop, debug, and understand Nextflow pipelines with AI-powered analysis and code generation. + +
+**Working with Nextflow** + +**Understand your pipeline structure**: + +``` +> Show me the structure of main.nf +``` + +``` +> What processes are defined in this pipeline? +``` + +**Generate a `nextflow.config` file**: + +``` +> /config +``` + +**Debug your pipeline**: + +``` +> /debug +``` + +``` +> Why is my pipeline failing? +``` + +**Generate a schema (`nextflow_schema.json`) file**: + +``` +> /schema +``` + + +**Convert scripts to Nextflow**: + +``` +> /convert-python-script +``` + +
+ +## Build containers with Wave + +Seqera AI can create containerized environments using Wave, without requiring you to write Dockerfiles. + +
+**Building containers with Wave** + +**Create a container with conda packages**: + +``` +> Create a container with samtools and bwa from bioconda +``` + +**Create a container with pip packages**: + +``` +> Build a container with pandas, numpy, and scikit-learn +``` + +**Get a container for a specific tool**: + +``` +> I need a container with FastQC version 0.12.1 +``` + +:::note +The assistant will generate a Wave container URL that you can use directly in your Nextflow pipelines or pull with Docker. +::: + +
+ +## Customize your session + +Customize your session with command-line options. + +
+**Customize your session** + +**Start in a specific directory**: + +```bash +seqera ai -w /path/to/project +``` + +**Set approval mode for local commands**: + +```bash +seqera ai -a full +``` + +
+ +## Exit the assistant + +End your Seqera AI session when done. + +
+**Exit the assistant** + +**To end your session**: + +- Type `exit` or `quit` +- Press `Ctrl+C` + +:::note +Your conversation history is preserved for the session but not stored permanently. +::: + +
+ +## Use slash commands + +Seqera AI includes built-in slash commands for common workflows. + +
+**Use slash commands** + +**Type `/` to see all available commands**: + +| Command | Description | +|---------|-------------| +| `/config` | Generate a nextflow.config file | +| `/schema` | Generate a Nextflow schema | +| `/debug` | Run nextflow lint and preview | +| `/debug-last-run` | Debug the last local run | +| `/debug-last-run-on-seqera` | Debug the last Platform run | +| `/migrate-from-wdl` | Convert WDL to Nextflow | +| `/migrate-from-snakemake` | Convert Snakemake to Nextflow | +| `/convert-python-script` | Convert Python script to Nextflow | +| `/convert-r-script` | Convert R script to Nextflow | +| `/convert-jupyter-notebook` | Convert Jupyter notebook to Nextflow | +| `/write-nf-test` | Write nf-tests for your pipeline | + +
+ +## Work with data + +Seqera AI helps you manage data through Platform data links and access reference datasets. + +
+**Working with data** + +**Browse data links**: + +``` +> List my data links +``` + +``` +> Show me the contents of my S3 data link +``` + +**Download and upload files**: + +``` +> Generate a download URL for results/final_report.html +``` + +``` +> Upload my local results to the data link +``` + +**Access reference data**: + +``` +> Find the human reference genome GRCh38 +``` + +``` +> Search for RNA-Seq test data +``` + +
+ +## Work with local files + +Seqera AI can interact with files in your current working directory. + +
+**Work with local files** + +**Start the assistant from your project folder**: + +```bash +cd /path/to/your/project +seqera ai +``` + +**Then, ask the assistant to help with local tasks**: + +``` +> Show me the structure of main.nf +``` + +``` +> Add a new process to handle quality control +``` + +:::note +Local file operations are controlled by [approval modes](./command-approval.md#approval-modes). By default, the assistant will ask for your approval before making changes outside your working directory or running potentially dangerous commands. +::: + +
+ +## Work with nf-core modules + +Seqera AI provides access to over 1,000 nf-core modules for common bioinformatics tasks. + +
+**Working with nf-core modules** + +**Search for modules**: + +``` +> Find nf-core modules for sequence alignment +``` + +``` +> What modules are available for variant calling? +``` + +**Get module details**: + +``` +> Show me how to use the nf-core/bwa/mem module +``` + +**Run a module**: + +``` +> Run FastQC on my FASTQ files +``` + +:::note +The assistant can generate the exact Nextflow command with proper parameters for your data. +::: + +
+ +## Work with Seqera Platform + +Use Seqera Platform capabilities to run and manage workflows at scale with AI assistance. + +
+**Working with Seqera Platform** + +**List your workflows**: + +``` +> List my recent workflows +``` + +**Launch a pipeline**: + +``` +> Launch the nf-core/rnaseq pipeline with the test profile +``` + +**Debug failed runs**: + +``` +> Why did my last workflow fail? +``` + +``` +> Get the logs for the failed task in my last run +``` + +
+ +

Learn more

+ +- [Seqera AI CLI](index.md): Seqera AI CLI overview +- [Installation](./installation.md): Detailed installation instructions +- [Authentication](./authentication.md): Log in, log out, and session management +- [Command approval](./command-approval.md): Control which commands run automatically +- [Troubleshooting](../troubleshooting_and_faqs/seqera-ai.md): Troubleshoot common errors diff --git a/platform-cloud/docs/troubleshooting_and_faqs/seqera-ai.md b/platform-cloud/docs/troubleshooting_and_faqs/seqera-ai.md new file mode 100644 index 000000000..b06598949 --- /dev/null +++ b/platform-cloud/docs/troubleshooting_and_faqs/seqera-ai.md @@ -0,0 +1,92 @@ +--- +title: "Seqera AI CLI" +description: "Seqera AI CLI troubleshooting." +date created: "2024-12-15" +last updated: "2025-12-15" +tags: [faq, help, seqera ai, troubleshooting] +--- + +## Installation + +##### Command not found + +If you see `seqera: command not found` after installation: + +1. Ensure the Python scripts directory is in your PATH: + + ```bash + # Restart your terminal or run + source ~/.bashrc # or ~/.zshrc + ``` + +1. Verify your installation location: + + ```bash + pip show seqera-ai + ``` + +##### Python version errors + +If you see errors about Python version: + +1. Check you have Python 3.13+ installed: + + ```bash + python3 --version + ``` + +1. If using multiple Python versions, specify the correct one: + + ```bash + python3.13 -m pip install seqera-ai + ``` + +##### Permission errors + +If you encounter permission errors during installation: + +1. Use the `--user` flag with pip + + ```bash + pip install --user seqera-ai + ``` + +## Authentication + +##### Browser doesn't open + +If the browser doesn't open automatically: + +1. Check the terminal output for a URL +1. Copy and paste the URL into your browser manually +1. Complete authentication in the browser + +##### Login timeout + +If authentication times out: + +1. Ensure you have internet connectivity +1. Check that `https://seqera.io` is accessible +1. Log out and log in again + +##### Token storage errors + +If you see keychain-related errors: + +1. Ensure your system keychain service is running +1. Check that you have permission to access the keychain + +:::note +The CLI will automatically fall back to file-based storage. +::: + +##### Session expired + +If your session has expired: + +1. Log out and log in again: + + ```bash + seqera logout + seqera login + ``` diff --git a/platform-cloud/docs/troubleshooting_and_faqs/troubleshooting.md b/platform-cloud/docs/troubleshooting_and_faqs/troubleshooting.md index d1cf45c80..b60d10424 100644 --- a/platform-cloud/docs/troubleshooting_and_faqs/troubleshooting.md +++ b/platform-cloud/docs/troubleshooting_and_faqs/troubleshooting.md @@ -1,5 +1,5 @@ --- -title: "General troubleshooting" +title: "General" description: "Troubleshooting Seqera Platform" date: "24 Apr 2023" tags: [troubleshooting, help]