# Getting started

> Sign in, find your way around, and understand organisations, spaces, folders and notes

Kribble is a knowledge base: you write notes, group them in folders and spaces, and share them with the people you work with. This page covers signing in, the layout of the app, and how your notes are organised.

## Signing in

Open your Kribble server's address in a browser. Your administrator gives you this address.

On the sign-in page, enter your **Username** (your email address works too) and **Password**, then click **Sign in**.

:::tabs{group="signin"}
::tab{label="New account"}
If your server lets people register, there is a **Sign up** tab. Fill in your email address, a username, a display name and a password, then click **Sign up**. If the server sends email, you'll see **Check your email**: click the link in the message to finish creating your account.

If there is no **Sign up** tab, the server is invite-only. Ask someone in your organisation to invite you. The invitation email has a link that opens an **Organization invite** page, where you can create your account and join in one step with **Accept invite & create account**. If you already have an account, sign in and click **Accept invite**.
::
::tab{label="Company directory (LDAP)"}
If your administrator connected Kribble to your company directory (LDAP or Active Directory), sign in on the same form with your directory username and password. The first time you do, Kribble creates your account for you. Depending on how the server is set up, you may also be added to organisations and teams automatically.
::
::tab{label="Forgotten password"}
Click **Forgot password?** under the password field and enter your email address. Kribble emails you a link to set a new password. This only works if your server is set up to send email; otherwise ask your administrator.
::
:::

### Signing in the CLI or desktop app

The [kribble CLI](../using-kribble/the-kribble-cli.md) and [the desktop app](../using-kribble/the-desktop-app.md) don't ask for your password. When you run `kribble login` (or connect a server in the desktop app), a page opens in your browser asking **Sign in the kribble CLI?**.

:::steps
::step
Check the code

---
Only continue if you just started the sign-in yourself and the code on the page matches the one in your terminal.
::
::step
Choose what it can reach

---
Under **Organization**, pick **All my organizations** (including ones you join later) or **Only** one of them. Under **Access**, pick **Read and write notes** if you'll use it with an AI agent that edits notes, or **Read notes only**.
::
::step
Approve

---
Click **Approve**. The page says **You're signed in** and you can go back to your terminal. Click **Deny** if you didn't start this.
::
:::

Approving creates an access token. You can revoke it later on the **Access Tokens** tab of the organisation's settings (for **All my organizations**, your personal vault's settings).

## Finding your way around

The app has three parts.

**The sidebar** on the left holds the search box, the list of spaces with their folders and notes, a **CLI & agents** link for setting up the command line and AI agents, and at the bottom the organisation switcher.

**The top bar** has the **Toggle sidebar** button (it hides and shows the sidebar), the breadcrumb showing where the open page sits, and on the right the note's actions when a note is open, the notification bell, and your avatar. On narrow screens the sidebar slides in over the page. On a phone the top bar shows the open page's name with its folder above it, and keeps only **Edit** (or **Save** while editing) beside a **⋯** menu that holds **Comments**, **Version history**, **Export as PDF** and **Copy as**.

**The main area** shows the page you opened: the home page, a space or folder overview, or a note.

### The home page

When you switch to an organisation, you land on its home page. It shows:

- the organisation's name and how many spaces and notes it has
- **Recently updated**: the eight notes changed most recently, with where they are and when they changed
- **Spaces**: a card for each space you can see, with its description and how many notes and folders it holds. Click a card to open the space. **New space** creates one.

To come back to the home page, pick the organisation again in the switcher.

## Organisations

Everything in Kribble lives in an organisation.

- **Your personal vault** is an organisation that only you own. Everyone gets one, with a first space called "My Notes". It's private until you share a space from it.
- **Team organisations** are shared with other people. Each member sees the spaces they've been given access to.

The organisation switcher at the bottom of the sidebar lists your organisations in groups: **Personal**, **Organizations**, and **Shared workspaces** (personal spaces other people have shared with you). Click one to switch to it. Hover an organisation and click the gear icon to open its settings.

### Creating an organisation

:::steps
::step
Open the switcher

---
Click the organisation switcher at the bottom of the sidebar and choose **Create organization**.
::
::step
Name it

---
Enter a **Name (URL slug)**, the short name used in addresses (for example `acme-corp`), and a **Display name** that people see (for example "Acme Corp"). A **Description** is optional. Choose the URL name with care: it can't be changed later.
::
::step
Create it

---
Click **Create organization**. You are its owner. To bring people in, see [Sharing and permissions](../using-kribble/sharing-and-permissions.md).
::
:::

## Spaces, folders and notes

Inside an organisation, your writing is arranged in three levels:

- **Spaces** are the top-level areas, such as "Engineering" or "Handbook". In a team organisation, each space has its own list of members, so a space is the unit of access.
- **Folders** group notes inside a space. Folders can contain other folders.
- **Notes** are the documents you write.

To create a space, click the **+** next to **Spaces** in the sidebar (**Create space**), or **New space** on the home page, type a name and press Enter. In a team organisation you need permission to create spaces.

To create a note or folder, right-click a space or folder in the sidebar (on a touch screen, press and hold it) and choose **New note** or **New folder**. Type a name and press Enter, or press Esc to cancel. You can also open a folder and use the **New note** and **New folder** buttons on its page. [Organising notes](../using-kribble/organising-notes.md) covers renaming, moving and deleting.

## Opening and reading notes

Click a note in the sidebar to open it. Click a space or folder to open its overview, which lists its **Contents** and the notes in it that changed recently.

A note opens for reading. Above the title, a line shows its revision number, who saved it last and when, and how long it is. On wide screens, an outline of the note's headings sits to the right of the text; click a heading to jump to it. To change the note, click **Edit** in the top bar (see [Writing notes](../using-kribble/writing-notes.md)).

To open a note in a new tab, Ctrl-click (⌘-click on a Mac) or middle-click it in the sidebar, or right-click it and choose **Open in new tab**. In a browser this opens a browser tab. The desktop app has its own tabs and can show notes side by side: see [The desktop app](../using-kribble/the-desktop-app.md).

Each note has its own address in the browser's address bar. Copy it to send a colleague straight to the note; they need access to its space to open it.

## Light and dark theme

Click your avatar in the top-right corner and choose **Light mode** or **Dark mode**. Kribble starts in dark mode and remembers your choice in this browser.

## Your profile

Click your avatar and choose **Profile & Preferences** to change your display name and avatar, change your password, or set the text size notes are shown in (under **Editor**). You can also change your avatar by clicking it at the top of the avatar menu.

## Keyboard shortcuts

These work anywhere in the app. On a Mac, use ⌘ where it says Ctrl.

| Shortcut | What it does |
| --- | --- |
| Ctrl+K | Open search |
| Ctrl+E | Move the keyboard focus to the sidebar |
| Ctrl+S | Save the note you're editing |
| Ctrl+Alt+M | Comment on the selected text |

The editor and the sidebar have more: see [Writing notes](../using-kribble/writing-notes.md) and [Organising notes](../using-kribble/organising-notes.md).
