9
2
Fork
You've already forked platform
2

docs: refresh CLI install instructions #367

Manually merged
ryansquared merged 1 commit from docs/issue-339-install-instructions into main 2026年07月09日 16:55:19 +02:00

Summary

  • Clarify that make install-cli uses the StageX/Docker CLI build and installs to $HOME/.local/bin/caution.
  • Document when to use make install-cli-untrusted for locksmith shard submission and host PC/SC support.
  • Update the getting-started deploy flow to describe generated caution.hcl and current Containerfile/Dockerfile build precedence instead of Procfile-focused guidance.

Closes #339

Test plan

  • git diff --check
  • markdownlint README.md src/cli/README.md not run: markdownlint is not installed in this environment.
## Summary - Clarify that `make install-cli` uses the StageX/Docker CLI build and installs to `$HOME/.local/bin/caution`. - Document when to use `make install-cli-untrusted` for locksmith shard submission and host PC/SC support. - Update the getting-started deploy flow to describe generated `caution.hcl` and current Containerfile/Dockerfile build precedence instead of Procfile-focused guidance. Closes #339 ## Test plan - `git diff --check` - `markdownlint README.md src/cli/README.md` not run: markdownlint is not installed in this environment.
ryansquared manually merged commit ed5ee29fc7 into main 2026年07月09日 16:55:19 +02:00
Sign in to join this conversation.
No reviewers
Labels
Clear labels
Compat/Breaking
Breaking change that won't be backward compatible
Component/Enclave-Builder
This issue affects Enclave Builder (git-push and CLI)
Component/Infrastructure
This issue affects generic Caution hosted infra components
Deploy/BYOC
Relates to Caution Bring-your-own-compute
Deploy/Full-managed
Relates to Caution fully managed cloud
Deploy/Self-hosted
Relates to Caution deployed on self-hosted infra
Interface/API
This issue affects the API
Interface/CLI
This issue affects the command line interface
Interface/Git
This issue affects the Git `push` interface
Interface/Web
This issue affects the web dashboard
Kind/Bug
Something is not working
Kind/Documentation
Documentation changes
Kind/Enhancement
Improve existing functionality
Kind/Feature
New functionality
Kind/Security
This is security issue
Kind/Testing
Issue or pull request related to testing
Priority
Critical
 The priority is critical
Priority
High
 The priority is high
Priority
Low
 The priority is low
Priority
Medium
 The priority is medium
Reviewed
Confirmed
 Issue has been confirmed
Reviewed
Duplicate
 This issue or pull request already exists
Reviewed
Invalid
 Invalid issue
Reviewed
Won't Fix
 This issue won't be fixed
Status
Abandoned
 Somebody has started to work on this but abandoned work
Status
Blocked
 Something is blocking this issue or pull request
Status
Need More Info
 Feedback is required to reproduce issue or to continue work
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
caution/platform!367
Reference in a new issue
caution/platform
No description provided.
Delete branch "docs/issue-339-install-instructions"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?