> ## Documentation Index
> Fetch the complete documentation index at: https://docs.claude-space.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation & Setup

> Get ClaudeSpace running on your machine in under 30 seconds

## Installation

### Option 1: Quick Install (Recommended)

```bash theme={null}
npm -i -g claude-space

# Run ClaudeSpace
claude-space

# or open in the porject canvas directly (where the .claude folder is located)
claude-space project .
```

The Code base is available in the following repository:

```bash theme={null}
# Clone the repository
git clone https://github.com/FilipeBorges1993/ClaudeSpaceElectron.git
cd ClaudeSpaceElectron

# Install dependencies
npm install

# Run ClaudeSpace
npm run dev
```

Success: ClaudeSpace opens automatically

***

## Configuration

### Claude API Setup

ClaudeSpace requires Claude API access for agent testing.

**Two authentication methods:**

#### Method 1: CLI Authentication (Recommended)

```bash theme={null}
# Install Claude CLI if not already installed
npm install -g @anthropic-ai/claude-cli

# Authenticate
claude auth login
```

**Benefits:**

* No API key management
* Automatic token refresh
* Secure credential storage

***

## Next Steps

Now that ClaudeSpace is installed, you're ready to build your first agent!

* [Workspace Basics](/docs/workspace-basics) - Understand project organization
* [Node Types Reference](/docs/node-types/overview) - Learn about all node types

***

### Having Issues?

**Get help:**

* [Report a bug](https://github.com/FilipeBorges1993/ClaudeSpaceElectron/issues)
* [Join Discord](https://discord.gg/2tr2S7yw)
* Check [existing issues](https://github.com/FilipeBorges1993/ClaudeSpaceElectron/issues) for solutions

**When reporting issues, include:**

* Node.js version (`node --version`)
* npm version (`npm --version`)
* Operating system and version
* Error messages (full text or screenshots)
* Steps to reproduce

***

## Development Commands

For developers working on ClaudeSpace:

```bash theme={null}
# Development mode with hot reload
npm run dev

# Type checking
npm run typecheck           # All
npm run typecheck:node      # Main process
npm run typecheck:web       # Renderer process

# Code quality
npm run lint                # ESLint check
npm run lint:fix            # Auto-fix issues
npm run format              # Prettier format

# Build for production
npm run build:mac           # macOS
npm run build:win           # Windows
npm run build:linux         # Linux
npm run build:all           # All platforms

# Clean build artifacts
rm -rf dist node_modules
npm install
```

***

## System Architecture

Understanding how ClaudeSpace works under the hood:

```
┌─────────────────────────────────────┐
│    Electron Main Process (Node.js)  │
│  - IPC handlers (80+ handlers)      │
│  - Agent session management         │
│  - File I/O operations              │
│  - Claude SDK integration           │
└──────────────┬──────────────────────┘
               │ IPC Bridge
┌──────────────▼──────────────────────┐
│     Vue 3 Renderer (Frontend)        │
│  - NodeCanvas (Vue Flow)            │
│  - ChatPage (testing UI)            │
│  - Settings & configuration         │
│  - Pinia state management           │
└─────────────────────────────────────┘
```

**Key directories:**

```
src/
├── main/           # Electron main process (Node.js)
├── preload/        # Context bridge & IPC
└── renderer/       # Vue 3 application (UI)
```

***

## License

ClaudeSpace is open source software licensed under the MIT License.

**What this means:**

* Free to use for personal and commercial projects
* Modify and distribute
* Private use
* No warranty or liability

See [LICENSE](../../LICENSE) for full details.

***

<div align="center">
  **Ready to build your first agent?**

  [Continue to agent basics →](/docs/workspace-basics)
</div>