You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/get-started/installation/index.mdx
+39-1Lines changed: 39 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,10 +4,17 @@ sidebar_label: Installation
4
4
5
5
importspecfrom"./sample.spec.json";
6
6
importCodeBlockfrom'@theme/CodeBlock';
7
+
importTabsfrom'@theme/Tabs';
8
+
importTabItemfrom'@theme/TabItem';
7
9
8
10
# Installation
9
11
10
-
Downloading and running Doc Detective is straightforward. Follow these steps to install Doc Detective and run your first test:
12
+
Downloading and running Doc Detective is straightforward. You can install Doc Detective using NPX (Node.js) or Docker. Follow the instructions for your preferred method:
13
+
14
+
Choose *NPX* if you have Node.js installed and want to install Doc Detective on your machine locally. Choose *Docker* if you can't install applications locally, prefer containerized environments, need to avoid Node.js installation, or want to isolate Doc Detective from your system.
15
+
16
+
<Tabs>
17
+
<TabItemvalue="npx"label="NPX"default>
11
18
12
19
1. Install prerequisites:
13
20
@@ -41,6 +48,37 @@ Downloading and running Doc Detective is straightforward. Follow these steps to
3. Run a test, pointing to the file you just created:
66
+
67
+
<CodeBlocklanguage="bash"title="Run test">
68
+
docker run -v .:/app docdetective/docdetective --input /app/sample.spec.json
69
+
</CodeBlock>
70
+
{/* step runShell:
71
+
command: "docker run -v .:/app docdetective/docdetective --input /app/sample.spec.json"
72
+
workingDirectory: "." */}
73
+
74
+
:::note
75
+
76
+
The `-v` argument mounts your current directory (`.`) to `/app` in the container, giving Doc Detective access to your test specification and enabling it to output results and screenshots. If your test specification is hosted at an HTTPS URL, the `-v` argument is not necessary.
77
+
78
+
:::
79
+
80
+
</TabItem>
81
+
</Tabs>
44
82
45
83
Congratulations! You've run your first test with Doc Detective. :tada:
0 commit comments