Appearance
Getting Started with Cortex CLI
This guide will help you install Cortex CLI and introduce you to its basic usage.
Installation
Choose one of the following methods to install Cortex CLI:
Using NPM (Recommended)
bash
npm install -g @cortex/cli
Using Homebrew (macOS)
bash
brew install cortex-cli
Manual Download
- Go to the Downloads page
- Select the package for your platform
- Extract the files to a location on your system
- Add the bin directory to your PATH
First Steps
After installing Cortex CLI, verify the installation by checking the version:
bash
cortex --version
Authenticate
Before using most features, you'll need to authenticate:
bash
cortex auth login
Follow the prompts to complete the authentication process.
Basic Commands
Here are some common commands to get you started:
bash
# Get help
cortex --help
# View available commands
cortex --commands
# Run a test
cortex test ./test-file.yml
Configuration
Create a configuration file to customize Cortex CLI:
bash
# Generate a default config file
cortex init
This creates a .cortexrc
file that you can edit to configure various aspects of the CLI.
Next Steps
- Explore Features to learn more about what you can do with Cortex CLI
- Check out the API Reference for detailed information about commands