​
Prerequisites

Ensure you have:
  1. Prime CLI installed and configured
  2. Username set on your profile
  3. Authenticate the CLI: 
    prime login

​
Creating a New Environment

​
Initialize Environment

Create a new environment with our starter template: 
prime env init <your-env-name>
This creates a template for a Python module with:
  • A README.md file (displayed on the Hub)
  • A pyproject.toml file for managing dependencies, versioning, tags, description, etc.
  • A Python file containing stub code for a load_environment function which returns a vf.Environment object — this will be the entrypoint for downstream applications to use your Environment, and should be used encapsulate any necessary preprocessing, resource provisioning, exposing configurable args, etc.

​
Develop Your Environment

After initialization, you can modify and test your environment. To install your environment locally, you can run: 
uv pip install -e .
To test/evaluate the environment: 
uv run vf-eval my-environment
Make sure to follow the verifiers library patterns when implementing your environment. Your environment should inherit from appropriate base classes and implement required methods.

​
Upload Your Environment

Once you’ve developed and tested your environment, push it to the hub: 
# Inside the environments/<your-env-name>/ directory
prime env push
This will upload your environment under your user account. You can also upload it to a team using: 
prime env push --team <team-username>
Once uploaded, your environment will be available for installation by others using prime env install owner/environment-name, unless you use the --visibility=PRIVATE flag.

​
Version Management

​
Updating Your Environment

When you make changes to your environment:
  1. Update the version in pyproject.toml
  2. Push the updated environment:
prime env push
The system will automatically create a new version while keeping previous versions available.

​
Getting Help