import React from 'react'; import { Link } from 'react-router-dom'; import { Button } from '@/components/ui/button'; import { ArrowRight, CheckCircle2 } from 'lucide-react'; const QuickStart = () => { return (

Quick Start

Get uptime.link running and monitoring your first endpoint in under 5 minutes.

{/* Prerequisites */}

Prerequisites

{/* Step 1 */}

1. Install the CLI

Install the uptime.link CLI globally using npm or pnpm:

npm install -g @uptime.link/cli

Or with pnpm:

pnpm add -g @uptime.link/cli
{/* Step 2 */}

2. Scan Your Network

Run the detector to discover services on your local network:

uptime scan

This will scan common ports and detect running services like HTTP servers, databases, and more.

{/* Step 3 */}

3. Add a Monitor

Add an endpoint to monitor:

{`uptime add https://api.example.com --interval 60`}

This adds the endpoint to your monitoring list with 60-second check intervals.

{/* Step 4 */}

4. View Status

Check the status of all monitored endpoints:

uptime status

You'll see a table with the current status, response time, and uptime percentage for each endpoint.

{/* Using the SDK */}

Using the SDK

For programmatic access, install the TypeScript SDK:

npm install @uptime.link/sdk
{`import { UptimeClient } from '@uptime.link/sdk';

const client = new UptimeClient();

// Check a single endpoint
const result = await client.check('https://api.example.com');
console.log(result.status, result.responseTime);

// Scan local network
const services = await client.scanNetwork();
console.log('Found services:', services);`}
{/* Next steps */}

Next Steps

); }; export default QuickStart;