dbt docs serve - Step-by-Step Execution

Concept Flow - dbt docs serve

Run 'dbt docs generate'

↓

Generate docs site files

↓

Run 'dbt docs serve'

↓

Start local web server

↓

Open browser at http://localhost:8080

↓

View interactive dbt documentation

↓

Stop server when done

This flow shows how dbt docs serve starts a local web server to display your project's documentation after generating it.

Execution Sample

dbt

dbt docs generate
 dbt docs serve

Generates documentation files and then starts a local server to view them in a browser.

Execution Table

Step	Command Run	Action	Result	Output
1	dbt docs generate	Generate docs files	Docs JSON and site files created	Files saved in target/catalog.json and target/index.html
2	dbt docs serve	Start local server	Server running on localhost:8080	Server logs showing URL
3	Open browser	Access docs site	Docs site loads	Interactive docs UI visible
4	Stop server	Terminate server process	Server stops	No server running
5	-	End	No further action	Process complete

💡 Server stops when user interrupts (Ctrl+C) or closes terminal

Variable Tracker

Variable	Before docs generate	After docs generate	After docs serve start	After server stop
docs_files_exist	False	True	True	True
server_running	False	False	True	False
browser_opened	False	False	True	False

Key Moments - 2 Insights

Why do I need to run 'dbt docs generate' before 'dbt docs serve'?

Because 'dbt docs serve' needs the generated documentation files to serve. See execution_table step 1 and 2 where files are created first, then the server starts.

What happens if I close the terminal while 'dbt docs serve' is running?

The server stops running because it runs in the terminal session. See execution_table step 4 where stopping the server ends the process.

Visual Quiz - 3 Questions

Look at the execution_table, what is the output after running 'dbt docs generate'?

A Server running on localhost:8080

B Interactive docs UI visible

C Files saved in target/catalog.json and target/index.html

D No server running

💡 Hint

Check execution_table row 1, Output column

At which step does the local server start running?

A Step 1

B Step 2

C Step 3

D Step 4

💡 Hint

Look at execution_table Step and Action columns

If you stop the server, what happens to the 'server_running' variable in variable_tracker?

A It changes from True to False

B It changes from False to True

C It stays True

D It becomes undefined

💡 Hint

See variable_tracker row for 'server_running' from 'After docs serve start' to 'After server stop'

Concept Snapshot

dbt docs serve
- Run 'dbt docs generate' first to create docs files
- Then run 'dbt docs serve' to start a local web server
- Open http://localhost:8080 in browser to view docs
- Stop server with Ctrl+C when done
- Shows interactive dbt project documentation

Full Transcript

The 'dbt docs serve' command starts a local web server to display your dbt project's documentation. First, you run 'dbt docs generate' to create the documentation files. Then, 'dbt docs serve' launches a server on your computer, usually at http://localhost:8080. You open this address in your web browser to see an interactive documentation site showing your models, sources, and tests. When you finish, you stop the server by closing the terminal or pressing Ctrl+C. This process helps you explore your dbt project documentation easily on your local machine.

Practice

1. What is the main purpose of the dbt docs serve command?

easy

A. To deploy your project to the cloud

B. To run your data models and create tables

C. To display your data project documentation in a web browser

D. To test your SQL queries for errors

Solution

1. Step 1: Understand the command's function

   dbt docs serve is used to show documentation, not to run models or deploy.

2. Step 2: Match the command to its purpose

   It opens a web browser with your project's docs, helping you explore models and their relationships.

3. Final Answer:

   To display your data project documentation in a web browser -> Option C

4. Quick Check:

   dbt docs serve = show docs [OK]

Hint: Remember: 'serve' means show docs in browser [OK]

Common Mistakes:

• Confusing docs serve with model run commands
• Thinking it deploys or tests code
• Assuming it updates models automatically

2. Which of the following is the correct way to start the documentation server in dbt?

easy

A. dbt docs build

B. dbt docs serve

C. dbt run docs

D. dbt serve docs

Solution

1. Step 1: Recall the exact command syntax

   The command to start the docs server is dbt docs serve.

2. Step 2: Eliminate incorrect options

   dbt docs build builds docs but does not serve; others are invalid syntax.

3. Final Answer:

   dbt docs serve -> Option B

4. Quick Check:

   Serve docs = dbt docs serve [OK]

Hint: Serve means start server; docs serve is correct [OK]

Common Mistakes:

• Using docs build instead of docs serve
• Swapping command order incorrectly
• Typing commands that don't exist

3. Consider this sequence of commands run in a dbt project:

dbt docs build
dbt docs serve

What will happen after running dbt docs serve?

medium

A. Nothing happens because docs serve only works with dbt cloud

B. The project models are rebuilt and deployed

C. An error occurs because docs build must be run after docs serve

D. A web browser opens showing the latest project documentation

Solution

1. Step 1: Understand the commands order

   dbt docs build creates the documentation files; dbt docs serve opens them in a browser.

2. Step 2: Predict the result of docs serve

   Since docs are built, docs serve will open a browser showing the docs.

3. Final Answer:

   A web browser opens showing the latest project documentation -> Option D

4. Quick Check:

   Build then serve = open docs [OK]

Hint: Build docs first, then serve to view [OK]

Common Mistakes:

• Thinking docs serve rebuilds models
• Believing docs serve causes errors without cloud
• Confusing docs build and run commands

4. You ran dbt docs serve but the browser does not open automatically. What is the most likely cause?

medium

A. You forgot to run dbt docs build first

B. Your dbt project has syntax errors

C. The command <code>dbt docs served

D. Your internet connection is down

Solution

1. Step 1: Check prerequisites for docs serve

   dbt docs serve requires docs to be built first with dbt docs build.

2. Step 2: Identify the cause of no browser opening

   If docs are not built, serve has no files to show, so browser won't open.

3. Final Answer:

   You forgot to run dbt docs build first -> Option A

4. Quick Check:

   Build docs before serve [OK]

Hint: Always build docs before serving [OK]

Common Mistakes:

• Assuming syntax errors block docs serve
• Thinking internet is needed for local docs
• Misspelling command but not checking

5. You want to share your dbt project's documentation with a teammate who is not on your local machine. Which approach using dbt docs serve is best?

hard

A. Run dbt docs serve --host 0.0.0.0 to allow external access on your network

B. Run dbt docs serve and share the local URL shown in the terminal

C. Run dbt docs build, then upload the generated docs site to a shared web server

D. Send your teammate the dbt_project.yml file to build docs themselves

Solution

1. Step 1: Understand default behavior of docs serve

   By default, dbt docs serve binds to localhost, so only your machine can access it.

2. Step 2: Enable external access

   Using --host 0.0.0.0 allows other devices on your network to access the docs server.

3. Step 3: Compare options

   Sharing local URL won't work externally; uploading docs is possible but outside docs serve; sending config file is indirect.

4. Final Answer:

   Run dbt docs serve --host 0.0.0.0 to allow external access on your network -> Option A

5. Quick Check:

   Serve with host 0.0.0.0 = share docs externally [OK]

Hint: Use --host 0.0.0.0 to share docs on network [OK]

Common Mistakes:

• Sharing localhost URL expecting remote access
• Not knowing how to expose server externally
• Confusing config files with docs content