Meta tags:
description=Local development with Nitric;

Headings (most frequently used words):

local, running, locally, development, get, started, build, deploy, languages, reference, misc, in, containers, enabling, https, dashboard, configuration,

Text of the page (most frequently used words):
api (51), and (30), the (28), your (27), file (21), application (21), route (20), bucket (19), secret (18), nitric (17), websocket (17), sql (17), local (15), delete (15), apis (14), key (14), you (13), get (13), with (12), topic (12), secrets (12), overview (12), this (11), run (11), development (11), can (11), topics (11), put (11), queue (11), job (11), for (10), storage (10), schedules (10), value (10), stores (10), websockets (9), batch (9), queues (9), schedule (9), https (8), running (8), containers (8), services (8), command (8), all (7), websites (7), databases (7), start (7), patch (7), post (7), dashboard (6), locally (6), http (6), view (6), version (6), using (5), access (5), set (5), features (5), testing (5), write (5), publish (5), them (5), files (5), submit (5), use (5), cloud (5), github (4), page (4), configuration (4), port (4), copied (4), copy (4), example (4), service (4), architecture (4), resources (4), custom (4), send (4), read (4), dequeue (4), enqueue (4), subscribe (4), keys (4), handler (4), search (4), guides (3), foundations (3), enabling (3), named (3), main (3), test (3), interact (3), trigger (3), also (3), over (3), preview (3), self (3), signed (3), that (3), runs (3), however (3), other (3), environment (3), close (3), cron (3), every (3), connectionstring (3), latest (3), google (3), azure (3), aws (3), follow (2), support (2), contributions (2), 2026 (2), edit (2), open (2), 6002 (2), const (2), configure (2), 6001 (2), url (2), default (2), provide (2), time (2), make (2), build (2), without (2), messages (2), buckets (2), including (2), observe (2), scheduled (2), tasks (2), jobs (2), automatic (2), cli (2), during (2), may (2), need (2), certificate (2), will (2), serve (2), pem (2), certificates (2), security (2), prefer (2), docker (2), one (2), depends (2), closely (2), resembles (2), how (2), would (2), getuploadurl (2), getdownloadurl (2), exists (2), async (2), messaging (2), started (2), docs (2), youtube, join, our, discord, server, inc, last, updated, jan, issue, have, feedback, mainapi, full, shown, below, experience, configured, yaml, browser, localhost, 49152, real, updates, ensuring, stay, sync, changes, many, these, possible, modules, isolation, could, create, subscriber, needing, first, publisher, dive, deep, into, connection, details, connecting, sending, manage, subscriptions, applications, uploading, downloading, queries, screen, used, database, migrations, client, explorer, visualization, their, connections, hosts, which, provides, graphical, interface, interacting, includes, following, feature, experimental, change, future, releases, place, directory, project, must, respectively, cert, tls, generate, keep, mind, are, not, trusted, browsers, cause, warnings, proxies, avoid, common, issues, most, cases, sufficient, supports, flag, slightly, harder, attach, debuggers, operating, systems, like, windows, macos, startup, slower, due, overhead, virtual, machine, builds, per, along, any, useful, once, starts, presented, list, see, link, where, live, diagram, various, code, containerization, making, easier, debug, recommended, way, versions, emulate, gateways, runtime, etc, ability, faq, examples, misc, env, vars, config, reference, dart, sqldatabase, uploadurl, downloadurl, listfiles, accessversion, newroute, newwebsocket, newschedule, newtopic, newbucket, newsqldatabase, newsecret, newqueue, newkv, newjob, newapi, connection_string, upload_url, download_url, methods, python, node, languages, install, adding, resource, types, providers, provider, extension, mappings, terraform, pulumi, deploy, hpc, deployment, infrastructure, projects, why, quick, installation, introduction, documentation,

Text of the page (random words):
get started local development nitric documentation foundations guides search search docs 1 9k search search docs introduction get started installation quick start guides foundations why nitric projects overview configuration infrastructure overview services resources security local development deployment architecture overview services apis schedules websockets websites storage key value stores async messaging queues topics sql databases secrets build apis batch ai ml hpc schedules websockets websites storage key value stores sql databases async messaging secrets deploy overview pulumi overview aws google cloud azure terraform overview aws google cloud azure service mappings aws apis batch schedules websockets websites storage key value stores sql databases topics queues secrets azure apis schedules websites storage key value stores sql databases topics queues secrets google cloud apis batch schedules websites storage key value stores sql databases topics queues secrets custom overview provider extension custom providers adding resource types install with docker languages overview node js overview apis api api get api post api put api delete api patch api route api route all api route get api route post api route put api route delete api route patch batch job job handler job submit http http key value stores kv kv get kv set kv delete kv keys topics topic topic publish topic subscribe queues queue queue enqueue queue dequeue secrets secret secret put secret version secret latest secret version access storage bucket bucket on bucket file bucket files file exists file read file write file delete file getdownloadurl file getuploadurl sql sql sql connectionstring schedules schedule schedule every schedule cron websockets websocket websocket on websocket send websocket close python overview apis api api get api post api put api delete api patch api methods api all batch job job handler job submit key value stores kv kv get kv set kv delete kv keys topics topic topic publish topic subscribe queues queue queue enqueue queue dequeue secrets secret secret put secret version secret latest secret version access storage bucket bucket on bucket file bucket files file read file write file delete file download_url file upload_url sql sql sql connection_string schedules schedule websockets websocket websocket on websocket send go overview resources newapi newjob newkv newqueue newsecret newsqldatabase newbucket newtopic newschedule newwebsocket apis api get api post api put api delete api patch api newroute api route all api route get api route post api route put api route delete api route patch batch job handler job submit key value stores kv get kv set kv delete kv keys topics topic publish topic subscribe queues queue enqueue queue dequeue secrets secret put secret accessversion secret access storage bucket on bucket listfiles bucket read bucket write bucket delete bucket downloadurl bucket uploadurl sql sqldatabase connectionstring schedules schedule every schedule cron websockets websocket on websocket send websocket close dart overview apis api api all api get api post api put api delete api patch api route api route all api route get api route post api route put api route delete api route patch batch job job handler job submit key value stores kv kv get kv set kv delete kv keys topics topic topic publish topic subscribe queues queue queue enqueue queue dequeue secrets secret secret put secret version secret latest secret version access storage bucket bucket on bucket file bucket files file exists file read file write file delete file getdownloadurl file getuploadurl sql sql sql connectionstring schedules schedule schedule every schedule cron websockets websocket websocket on websocket send websocket close reference cli preview features other config env vars custom service containers misc examples faq contributions support local development one of the key features of nitric is the ability to run your application locally for development and testing using an environment that closely resembles how the application would run in the cloud using the nitric start command you can start a local environment with local versions of the services resources your application depends on for example nitric can emulate api and websocket gateways trigger scheduled services and provide runtime apis for queues buckets secrets key value stores etc the start command runs your code without containerization making it easier to debug and test your application locally this is the recommended way to run your application during development however if you prefer to run your application in containers you can use the nitric run command running locally copy copied nitric start once the command starts you ll be presented with a list of running apis and other services you ll also see a link to the local development dashboard where you can view a live architecture diagram of your running application and interact with various services for testing running locally in containers if you prefer to run your application in containers you can use the nitric run command this command builds and runs your application in docker containers one per service along with any other services it depends on this is useful for testing your application in an environment that closely resembles how it would run in the cloud however running your application in containers can make it slightly harder attach debuggers and on operating systems like windows and macos the startup time can be slower due to the overhead of running the containers in a virtual machine copy copied nitric run enabling local https by default nitric runs your application s apis and http proxies over http to avoid common issues with self signed certificates in most cases this is sufficient for local development however if you need to test your application with https the nitric start command supports enabling https using the https preview flag this command will generate a self signed certificate and key for your application and use them to serve your application over https keep in mind that self signed certificates are not trusted by browsers and may cause security warnings copy copied nitric start https preview if you need to use a custom certificate and key you can place them in the nitric tls directory in your project and nitric will use them to serve your application over https the files must be named cert pem and key pem respectively this feature is experimental and may change in future releases local dashboard the nitric cli also hosts a local development dashboard which provides a graphical interface for interacting with your application during development the dashboard includes the following features architecture an automatic architecture visualization of your application including all services resources and their connections api explorer an automatic http client for testing your apis batch jobs observe batch service jobs and submit tasks databases view your sql databases and interact with them using sql queries this screen can also be used to trigger database migrations schedules trigger and observe scheduled tasks storage view your applications buckets and interact with them including uploading and downloading files topics view topics and subscriptions and publish messages to topics secrets view and manage your application secrets websockets dive deep into connection details connecting and sending messages websites view your websites many of these features make it possible to build and testing modules of your application in isolation for example you can could create and test a topic and subscriber without needing to first write the publisher all features provide real time updates ensuring you stay in sync with your application changes to access the development dashboard open the local url in your browser by default the url is set to http localhost 49152 configuration the local development experience can be configured using a local nitric yaml file a full example with example configuration is shown below copy copied apis configure an api named main to run on port 6001 e g const mainapi api main main port 6001 websockets configure a websocket named ws to run on port 6002 e g const ws websocket ws ws port 6002 edit this page on github have feedback on this page open github issue last updated on jan 5 2026 on this page running locally running locally in containers enabling local https local dashboard configuration edit this page on github 2026 nitric inc contributions support foundations guides follow us on x follow us on github join our discord server youtube