Quick Start

This guide will walk you through Chaterm's core features. Upon completion, you'll be familiar with common terminal Agent operations in Chaterm.

Step 1: Installation and Login

Install Chaterm

1. Download Chaterm:

⤓Download Chaterm

2. Launch the Chaterm application

Login to Your Account

Chaterm supports multiple login methods:

Domestic Version:

• Email verification code login: Enter your email address and receive a verification code to login
• Username and password login: Login with username and password
• Third-party login: Supports Google and GitHub login

International Version:

• Email verification code login: Enter your email address and receive a verification code to login
• Username and password login: Login with username and password
• Third-party login: Supports QQ login

Tip

• When using email login for the first time, new users will be automatically registered and logged in
• If you don't want to login temporarily, you can click the "Skip" button, but you won't be able to use the built-in AI model capabilities without logging in

Step 2: Add Hosts

Add Personal Host

1. Click "Workspace" (Hosts) in the left menu
2. Click the "Add" button in the top right corner or the "+" button in the bottom right corner
3. Fill in the host information:
   • Personal or Enterprise: Select "Personal"
   • Connection IP or Address: Enter the host's IP address or domain name
   • Port: SSH port, default is 22
   • Username: SSH login username
   • Authentication Method:
     • Password authentication: Enter SSH login password
     • Key authentication: Select an added key (needs to be added in key management first)
   • SSH Proxy Settings (optional): Configure if you need to connect through a proxy
   • Alias: Set a recognizable name for the host
   • Group: Select or enter the group the host belongs to
4. Click the "Create" button to complete the addition

Connect to Host

In the host list, click any host to establish an SSH connection and open a terminal window.

Step 3: Experience AI Features

Open AI Chat Panel

There are two ways to open AI chat:

1. Click the "AI" icon in the left menu
2. Use keyboard shortcuts in the terminal:
   • macOS: Cmd + L
   • Windows/Linux: Ctrl + L

Create New Conversation

1. Click the "New Conversation" button
2. Select interaction mode:
   • Chat Mode: Chat with AI, learn, brainstorm (cannot operate servers)
   • Command Mode: Execute commands in the current active terminal, AI will plan tasks and execute commands
   • Agent Mode: Execute command queries on any host, troubleshoot errors, handle tasks, and more
3. @Host (Agent Mode): You can @ multiple hosts for operations
4. Select Large Model: Choose different models from the model list
5. Start the conversation

AI Interaction in Terminal

In the terminal window, there are two ways to quickly use AI:

1. Keyboard shortcut Ctrl+K or Cmd+K: Opens a dialog box, enter the operation you want to perform
2. Keyboard shortcut Ctrl+L or Cmd+L: Quickly opens AI chat, AI will automatically get the current terminal's context information

Common Use Case Examples

Use Case 1: System Monitoring

@127.0.0.1 Check system memory usage
@server1 Check disk space usage
@server2 View currently running processes and CPU usage

Use Case 2: Log Analysis

@server1 Analyze error logs from the last hour and identify the cause
@server2 View application logs and identify performance bottlenecks

Use Case 3: File Operations

@127.0.0.1 Find recently modified files
@server1 Backup important configuration files to /backup directory
@server2 Clean up temporary files older than 7 days

Use Case 4: Service Management

@server1 Check Nginx service status, restart if abnormal
@server2 View Docker container running status
@server3 Check database connection status

Use Case 5: Network Diagnostics

@server1 Check network connection status
@server2 Test connectivity to a specific host
@server3 View port occupancy

Congratulations! You have successfully completed the Chaterm quick start. Now you can start using the AI-powered intelligent terminal to improve your work efficiency!