KRNL Platform Guidebook
KRNL Platformkrnl.xyz
  • Introduction
    • Introduction
    • How Does kOS Work?
  • Setup
    • Getting Started with KRNL
    • Quick Start (CLI)
    • Quick Start (Online IDE)
      • Quick Start (Remix IDE)
      • Quick Start (Atlas IDE)
    • create-krnl-app
    • Platform Registration
  • Kernel
    • What are Kernels?
    • Kernel Registration
      • Kernel Registration (on-chain)
      • Kernel Registration (off-chain)
    • Supported OpenAPI (Off-chain Kernel)
    • Staking
  • Smart Contract
    • Steps for Smart Contract Developers
    • Choosing Kernel(s)
    • Token Authority
      • What is a Token Authority?
      • How to Build a Token Authority?
      • Generic Token Authority
      • How to Deploy a Token Authority on Oasis?
    • Decoding Kernel Responses in Solidity
    • How to Integrate Your Smart Contract with kOS?
    • Smart Contract Registration
  • DApp
    • dApp Registration
    • KRNL SDK Installation
    • Usage
    • KRNL Node RPC
  • Miscellaneous
    • Overview
    • What is the KRNL Platform?
    • What are You Trying to BUIDL?
    • Smart Contract Fundamentals
      • Why Do I Have to Register a Smart Contract?
      • How to Deploy a Smart Contract?
    • Recommended Kernels List
  • Helpful Resources
    • New to Web3?
    • Dictionary
    • Testnet Faucets
    • How to Get Etherscan API Key?
  • Litepaper
    • Litepaper
      • Overview
      • Problem Statement
      • Current State Does Not Solve the Problem
      • Introducing Kernels
      • Ecosystem of Kernels
      • The KRNL Operating System (kOS)
      • Decentralization and Security Considerations
      • Use Cases for KRNL
  • Appendices
    • FAQ
    • Bounty Program
    • Social Medias
    • Thank You
  • Workshop
    • KRNL Workshop
    • Speed's Workshop
Powered by GitBook
On this page
  • Platform Support (OS)
  • Installation and Setup
  • Installation
  • Init
  • Setup
  • Deploy, Verify, and Register
  • What's Next?
  • Frequently Asked Questions

Was this helpful?

  1. Setup

Quick Start (CLI)

Currently, "krnl-cli' is temporarily unavailable.

Please, use "Quick Start (Online IDE)" instead.


Platform Support (OS)

At the moment, the KRNL CLI is built using a Foundry project as a template.

Platform
Version

macOS

Sequoia (15+)

Linux

Ubuntu 24.04.1, Debian (X)

Windows

requires WSL 2

At the time of making this documentation, Foundry cannot be used on Powershell or CMD (Windows)


Installation and Setup

The KRNL CLI is an application that unifies the setup, deployment, verification, and registration of smart contracts on the KRNL platform into one place.

Installation

npm install -g krnl-cli

Init

This initializes a sample project, containing everything you need to get started with kOS.

krnl init

Setup

krnl setup

When running the setup command, the CLI will ask you for the following information:

  • Etherscan API Key - Used to verify your deployed smart contracts

  • Sepolia RPC URL - Can be configured to point to a local node, otherwise it will default to: https://1rpc.io/sepolia

  • Oasis Sapphire Wallet Private Key - Used for deploying your Token Authority contract

  • Ethereum (Sepolia) Wallet Private Key - Used for deploying your Smart Contract


Deploy, Verify, and Register

krnl deploy-all

This command will execute several functions:

  1. Deploy Token Authority smart contract on Oasis Sapphire network

  2. Verify Token Authority contract on Sourcify

  3. Deploy your main smart contract on Sepolia testnet

  4. Verify your main smart contract on Etherscan, using your Etherscan API Key

  5. Register your deployed smart contracts on the KRNL Registry

After successfully executing this command, the CLI puts you in a stronger position to add new functionalities to your dApp via kOS.


What's Next?


Frequently Asked Questions

"Forge not found"

This is an error which occurs when your forge installation is not found. This issue can be resolved by running the command krnl setup in your terminal, which will install forge binaries globally in your local system.

Compilation fail due to version mismatch

This error occurs when there is a mismatch between the Solidity compiler version and the version specified in your contract. To resolve this, make sure to use pragma solidity 0.8.24 as the Solidity version in your contract.


PreviousGetting Started with KRNLNextQuick Start (Online IDE)

Last updated 22 hours ago

Was this helpful?

Kernel ID(s) - Choose your desired functionalities from the .

Create a dApp by following our or by using the .

Explore different kernel examples .

KRNL Platform "Explore" page
tutorial
KRNL Sandbox
here