Getting Started

Your first steps with TeamIDE

Overview

This guide walks you through the basics of using TeamIDE: connecting your GitHub account, opening a repository, editing files, and making commits.

Step 1: Connect GitHub

Before you can access your repositories, connect your GitHub account.

1. Open Settings (gear icon in the bottom-left)
2. Go to the Accounts tab
3. Click Add GitHub Account
4. Copy the device code shown
5. Click Open GitHub - a browser window opens
6. Paste the code on GitHub and authorize
7. Return to TeamIDE - your account connects automatically

Your GitHub repositories and organizations are now available.

Step 2: Open a Repository

From GitHub

1. Click the Owner dropdown in the top bar
2. Select your username or an organization
3. Click the Repository dropdown
4. Select a repository

The repository loads in the Code module.

Clone a New Repository

1. Click Import in the top bar
2. Enter the repository URL or search by name
3. Click Clone

Local Repository

1. Click Import in the top bar
2. Select Import Local Repository
3. Choose a folder from your computer
4. Click Import

Step 3: Explore Files

The Explorer panel on the left shows your project files.

• Click a file to open it in the editor
• Click the arrow next to folders to expand/collapse
• Right-click for options (rename, delete, open in terminal)

Toolbar Buttons

Step 4: Edit Files

Click a file to open it in the editor. Files open as tabs - you can have multiple files open.

Saving

• Auto-save: Files save automatically after you stop typing (default: 1 second)
• Manual save: Press Cmd+S (Mac) or Ctrl+S (Windows/Linux)

Unsaved files show a white dot on the tab.

Editor Features

• Syntax highlighting for many languages
• Line numbers
• Code folding (collapse blocks)
• Find & Replace (Cmd/Ctrl+F)

Step 5: Use the Terminal

Access the terminal to run commands.

Open Terminal

• Click the Terminal icon in the module bar (left side)
• The terminal overlay appears

Basic Commands

# Install dependencies
npm install

# Run development server
npm run dev

# Check git status
git status

Press the Terminal icon again to close the overlay.

Step 6: Make a Commit

After editing files, commit your changes to Git.

View Changes

1. In the Code module, click the Changes tab (left panel)
2. You’ll see modified files listed

Stage Files

• Click the checkbox next to files you want to commit
• Or click Stage All to stage everything

Commit

1. Enter a Summary (required) - describes what you changed
2. Optionally add a Description for more detail
3. Click Commit to [branch-name]

Your changes are now committed locally.

Step 7: Push to GitHub

After committing, push your changes to GitHub.

1. Open the Terminal
2. Run: git push

Your commits are now on GitHub.

Quick Tips

Next Steps

Now that you know the basics:

• Code Module - Learn all editor features
• Terminal Module - Master the terminal
• Git Integration - Full Git workflow
• Settings - Customize TeamIDE
• Keyboard Shortcuts - Work faster

Changelog