Prerequisites¶
Before installing Soong CLI, you'll need to set up your Lambda Labs account and gather the required credentials.
1. Create a Lambda Labs Account¶
If you don't already have a Lambda Labs account:
- Go to cloud.lambdalabs.com
- Click Sign Up and create an account
- Verify your email address
- Add a payment method to your account
Payment Method Required
Lambda Labs requires a valid payment method before you can launch GPU instances. Make sure to add your payment information in the account settings.
2. Generate an API Key¶
Soong CLI uses the Lambda Labs API to manage instances. You'll need an API key to authenticate.
Steps to Generate an API Key¶
- Log in to cloud.lambdalabs.com
- Navigate to Account Settings → API Keys
- Click Generate New API Key
- Copy the API key immediately—you won't be able to see it again
- Store the API key securely (you'll need it during configuration)
Keep Your API Key Secret
Your API key provides full access to your Lambda Labs account. Never share it or commit it to version control.
Example API Key Format¶
3. Create and Upload SSH Keys (Optional)¶
Soong CLI uses SSH to connect to your instances. If you don't have an SSH key uploaded to Lambda Labs, Soong will detect this when you try to launch an instance and prompt you to add one.
You can skip this step
Soong will check for SSH keys when launching and guide you if none are found.
Generate an SSH Key Pair (if you don't have one)¶
Upload SSH Key to Lambda Labs¶
- Log in to cloud.lambdalabs.com
- Navigate to Account Settings → SSH Keys
- Click Add SSH Key
- Paste your public key (the content of
id_ed25519.pub) - Give it a memorable name (e.g., "My Laptop")
- Click Save
Public Key Only
Upload your public key (id_ed25519.pub), NOT your private key (id_ed25519). Never share your private key with anyone.
4. Create a Persistent Filesystem (Recommended)¶
Lambda Labs instances are ephemeral—when stopped, all data is lost. A persistent filesystem preserves your data across instances.
Why Use a Persistent Filesystem?¶
- Preserve models: Downloaded models persist across sessions
- Save work: Code, datasets, and results aren't lost
- Faster startup: No need to re-download dependencies
Create a Persistent Filesystem¶
- Log in to cloud.lambdalabs.com
- Navigate to Storage → Filesystems
- Click Create Filesystem
- Choose a region (must match your instance region)
- Set the size (recommended: 512GB or larger for ML models)
- Name your filesystem (e.g., "ml-workspace")
- Click Create
Filesystem Naming
Use a descriptive name—you'll reference it during Soong CLI configuration.
Filesystem Costs¶
Persistent filesystems are charged separately from instances:
- Cost: ~$0.20/GB/month
- Example: 512GB filesystem = ~$100/month
5. Verify Prerequisites¶
Before proceeding, make sure you have:
- Lambda Labs account with verified email
- Payment method added to your account
- Lambda Labs API key generated and saved
- SSH key pair (optional - Soong will prompt when needed)
- Persistent filesystem created (optional but recommended)
Next Steps¶
Once you've completed all prerequisites, proceed to Installation to install Soong CLI.
Troubleshooting¶
"Unable to generate API key"¶
Solution: Make sure you've verified your email address and added a payment method to your account.
"SSH key upload failed"¶
Solution: Verify you're uploading your public key (id_ed25519.pub), not your private key. The public key should start with ssh-ed25519 or ssh-rsa.
"Filesystem creation unavailable in my region"¶
Solution: Persistent filesystems are only available in certain Lambda Labs regions. Choose a region that supports filesystems, then launch instances in that same region.
Lambda Labs Documentation
For more details on Lambda Labs features, see the official Lambda Labs documentation.