Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: split CLI implementation into a new iroh-cli crate #2076

Merged
merged 10 commits into from
Mar 14, 2024
Merged

feat: split CLI implementation into a new iroh-cli crate #2076

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
3cd50aa
feat: split CLI implementation into a new iroh-cli crate
dignifiedquire Mar 13, 2024
2871311
cleanup
dignifiedquire Mar 13, 2024
cccd00d
ci: drop unused feature
dignifiedquire Mar 13, 2024
bf14959
fixup: dep
dignifiedquire Mar 13, 2024
3ffdca4
fixups
dignifiedquire Mar 13, 2024
457974d
sort deps
dignifiedquire Mar 13, 2024
8fbd8ce
fixup doc comments
flub Mar 13, 2024
6b29fe0
do not build docs for iroh-cli
flub Mar 13, 2024
6f4a434
Revert "fixup doc comments"
flub Mar 13, 2024
aa2da80
Merge branch 'main' into feat-cli-crate
dignifiedquire Mar 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ jobs:

- name: Check MSRV all features
run: |
cargo +$MSRV check --workspace --all-targets --features cli
cargo +$MSRV check --workspace --all-targets
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The name does not really match what it does. I don't know which one it should be though? Maybe it should be --all-features?


cargo_deny:
timeout-minutes: 30
Expand Down
158 changes: 129 additions & 29 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ members = [
"iroh-net",
"iroh-sync",
"iroh-test",
"iroh-net/bench"
"iroh-net/bench",
"iroh-cli"
]
resolver = "2"

Expand Down
16 changes: 10 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,21 @@ Iroh is a protocol for syncing & moving bytes. Bytes of any size, on any device.

## Using Iroh

Iroh is delivered as a Rust library and a CLI. Run `cargo build` to build the `iroh` CLI. To use iroh in your project, check out https://iroh.computer/docs/install to get started.
Iroh is delivered as a Rust library and a CLI.

### As a library
Disable default features when using `iroh` as a library:
`iroh = { version = "...", default-features = false }`
### Library

This removes dependencies that are only relevant when using `iroh` as a cli.
Run `cargo add iroh`, to add `iroh` to your project.

### CLI

Check out https://iroh.computer/docs/install to get started.

The implementation lives in the `iroh-cli` crate.

# License

Copyright 2023 N0, INC.
Copyright 2024 N0, INC.

This project is licensed under either of

Expand Down
Loading
Loading