Skip to main content

Installation

Requirements​

  • Node.js 18.0 or higher
  • npm 8.0 or higher (comes with Node.js)
  • Git (for version control features)

Install via npm​

npm install -g archicore

Verify Installation​

archicore --version
# ArchiCore v0.1.0

Authentication​

Before using ArchiCore, you need to authenticate:

archicore login

This will:

  1. Open your browser to the ArchiCore login page
  2. After login, automatically configure the CLI
  3. Store credentials securely

Device Code Flow (Headless)​

For servers without a browser:

archicore login --device-code

This displays a code to enter at ArchiCore Device Auth.

Initialize a Project​

Navigate to your project directory and run:

cd /path/to/your/project
archicore init

This creates a .archicore/ directory with default configuration.

Updating​

npm update -g archicore

Uninstalling​

npm uninstall -g archicore

To also remove configuration:

rm -rf ~/.archicore

Platform-Specific Notes​

Windows​

Use PowerShell or Git Bash. Command Prompt works but has limited features.

# PowerShell
npm install -g archicore

Linux​

You may need sudo for global install:

sudo npm install -g archicore

Or configure npm to use a local directory:

mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
npm install -g archicore

macOS​

npm install -g archicore

If you get permission errors:

sudo chown -R $(whoami) $(npm config get prefix)/{lib/node_modules,bin,share}
npm install -g archicore

Troubleshooting​

"EACCES: permission denied"​

Don't use sudo npm install. Instead, fix npm permissions:

mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH

"archicore: command not found"​

Ensure npm global bin is in PATH:

export PATH="$(npm bin -g):$PATH"

Add to ~/.bashrc or ~/.zshrc to make permanent.

Behind a Proxy​

npm config set proxy http://proxy.company.com:8080
npm config set https-proxy http://proxy.company.com:8080
npm install -g archicore