Compare commits

...

59 Commits

Author SHA1 Message Date
J / Jacob Babich
9f34e73729 chore: add package descriptions so that they can actually be published 2024-10-05 23:44:34 -04:00
J
4ea63f731e Merge pull request #11 from babichjacob/release-plz-2024-10-06T03-28-10Z
chore: release
2024-10-05 23:37:29 -04:00
release-plz-for-ac-qu-ai-nt[bot]
062c31bd9a chore: release 2024-10-06 03:34:57 +00:00
J / Jacob Babich
7d76b61c76 style: run cargo fmt 2024-10-05 23:34:35 -04:00
J / Jacob Babich
83fa6398cf ci: move the description of the checking / building command (which varies from whether they are being run for minimal or for latest (typically) versions of dependencies) to the job name instead of the command name 2024-10-05 23:34:20 -04:00
J / Jacob Babich
18cb5043cf feat: initialize core, gui-eframe, and tui-ratatui crates and use them in the multibinary 2024-10-05 23:27:47 -04:00
J / Jacob Babich
dbccf23a50 ci: incorporate minimal dependency versioning checking / building into the main job 2024-10-05 19:48:01 -04:00
J / Jacob Babich
a2c3013fd5 ci: can't use the matrix strategy for determining which binary to compile and upload, so copying and pasting instead unfortunately until https://github.com/actions/runner/issues/1985 is fixed 2024-10-05 19:31:29 -04:00
J
1175fa22d6 Merge pull request #10 from babichjacob/release-plz-2024-10-05T07-02-29Z
Some checks are pending
Check, build, and test / formatting (push) Waiting to run
Check, build, and test / Check and build ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }}) (map[install_prerequisite:sudo apt-get update && sudo apt-get install gcc-aarch64-linux-gnu runner:ubuntu-latest target:aarch64-unknown-linux-gnu]) (push) Waiting to run
Check, build, and test / Check and build ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }}) (map[install_prerequisite:sudo apt-get update && sudo apt-get install gcc-aarch64-linux-gnu runner:ubuntu-latest target:aarch64-unknown-linux-musl]) (push) Waiting to run
Check, build, and test / Check and build ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }}) (map[runner:macos-latest target:aarch64-apple-darwin]) (push) Waiting to run
Check, build, and test / Check and build ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }}) (map[runner:macos-latest target:x86_64-apple-darwin]) (push) Waiting to run
Check, build, and test / Check and build ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }}) (map[runner:ubuntu-latest target:x86_64-unknown-linux-gnu]) (push) Waiting to run
Check, build, and test / Check and build ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }}) (map[runner:ubuntu-latest target:x86_64-unknown-linux-musl]) (push) Waiting to run
Check, build, and test / Check and build ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }}) (map[runner:windows-latest target:aarch64-pc-windows-msvc]) (push) Waiting to run
Check, build, and test / Check and build ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }}) (map[runner:windows-latest target:x86_64-pc-windows-gnu]) (push) Waiting to run
Check, build, and test / Check and build ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }}) (map[runner:windows-latest target:x86_64-pc-windows-msvc]) (push) Waiting to run
Check, build, and test / Test ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }}) (map[runner:macos-latest target:aarch64-apple-darwin]) (push) Waiting to run
Check, build, and test / Test ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }}) (map[runner:macos-latest target:x86_64-apple-darwin]) (push) Waiting to run
Check, build, and test / Test ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }}) (map[runner:ubuntu-latest target:x86_64-unknown-linux-gnu]) (push) Waiting to run
Check, build, and test / Test ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }}) (map[runner:ubuntu-latest target:x86_64-unknown-linux-musl]) (push) Waiting to run
Check, build, and test / Test ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }}) (map[runner:windows-latest target:x86_64-pc-windows-gnu]) (push) Waiting to run
Check, build, and test / Test ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }}) (map[runner:windows-latest target:x86_64-pc-windows-msvc]) (push) Waiting to run
Check, build, and test / minimal-dependencies-check-build-and-test (push) Waiting to run
Release-plz / Release-plz (push) Waiting to run
chore: release
2024-10-05 03:03:09 -04:00
release-plz-for-ac-qu-ai-nt[bot]
13b7053386 chore: release 2024-10-05 07:02:30 +00:00
J / Jacob Babich
972129536f chore: change Hello, world! to What's up world? to allow me to cut a release 2024-10-05 03:01:41 -04:00
J / Jacob Babich
ae7de503a4 ci: try wrapping the if condition to make sure the release matches with ${{ and }} 2024-10-05 03:00:05 -04:00
J
21df8d1781 Merge pull request #9 from babichjacob/release-plz-2024-10-05T06-53-32Z
chore(ac-qu-ai-nt): release v0.0.6
2024-10-05 02:57:35 -04:00
release-plz-for-ac-qu-ai-nt[bot]
e5707cb106 chore: release 2024-10-05 06:55:34 +00:00
J / Jacob Babich
7f450568f2 fix: cover the new cases of Command for GuiEframe and TuiRatatui 2024-10-05 02:55:12 -04:00
J / Jacob Babich
e2bf39e2c1 chore: correctly add gui-eframe and tui-ratatui as features this time around 2024-10-05 02:53:03 -04:00
J / Jacob Babich
e96081486a chore: add gui-eframe and tui-ratatui as subcommands with aliases gui and tui respectively 2024-10-05 02:50:10 -04:00
J / Jacob Babich
63ffbf9f1a chore: add gui-eframe and tui-ratatui as features 2024-10-05 02:49:53 -04:00
J / Jacob Babich
65bdf6dd04 ci: try single quoting 2024-10-05 02:47:09 -04:00
J
43682dc3d3 Merge pull request #8 from babichjacob/release-plz-2024-10-05T06-40-33Z
chore(ac-qu-ai-nt): release v0.0.5
2024-10-05 02:43:56 -04:00
release-plz-for-ac-qu-ai-nt[bot]
c25e628aa9 chore: release 2024-10-05 06:40:34 +00:00
J / Jacob Babich
1177376450 chore!: put accessing the cli under a subcommand like the README suggests it would be 2024-10-05 02:40:09 -04:00
J / Jacob Babich
f37d56edba ci: only compile for releases for the relevant crate 2024-10-05 02:28:19 -04:00
J / Jacob Babich
1854dc429c ci: compile binaries for various targets on release 2024-10-05 01:54:42 -04:00
J / Jacob Babich
3e69d65bcc ci: aim to increase cache reuse 2024-10-05 01:53:12 -04:00
J / Jacob Babich
4c04f21dcb ci: string quote the paths because starting with * was trying to reference a YAML alias
Some checks are pending
Release-plz / Release-plz (push) Waiting to run
2024-10-04 22:05:31 -04:00
J / Jacob Babich
c0ec64f06c ci: prevent irrelevant file changes from triggering the check, build, and test workflow 2024-10-04 19:22:16 -04:00
J / Jacob Babich
70e20e2e04 ci: remove requirement to build for aarch64-pc-windows-gnullvm until I can understand how to do it in GitHub Actions 2024-10-04 18:52:08 -04:00
J / Jacob Babich
12107daf6b ci: install Nextest for the test job (because I accidentally deleted it) 2024-10-04 18:09:10 -04:00
J / Jacob Babich
839f219469 ci: turn fail-fast back on 2024-10-04 18:07:24 -04:00
J / Jacob Babich
56ad1de3d4 ci: phrasing change from "direct minimal dependencies" to "minimal direct dependencies" 2024-10-04 18:06:50 -04:00
J / Jacob Babich
30dee5efa7 ci: lower all job timeouts because they shouldn't reasonably take that long and I would like it to be raised as a problem with my project if it ever starts exceeding the time specified 2024-10-04 18:06:02 -04:00
J / Jacob Babich
52297c7b43 ci: split testing off from checking and building 2024-10-04 18:04:31 -04:00
J / Jacob Babich
b1520ae76b ci: specify prerequisite_install for aarch64 linux like I meant to (whereas it was on x86_64-unknown-linux-gnu before) 2024-10-04 17:55:18 -04:00
J / Jacob Babich
ac42b4861c ci: use sudo for prerequisite installation 2024-10-04 17:53:04 -04:00
J / Jacob Babich
499562853c ci: write a cleaner name for the check / build / test job 2024-10-04 17:51:50 -04:00
J / Jacob Babich
d6922c30c5 ci: specify CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER too 2024-10-04 17:50:15 -04:00
J / Jacob Babich
b5935b8ab5 ci: try having prerequisite installation step where needed 2024-10-04 17:49:19 -04:00
J / Jacob Babich
5e0a2326ca ci: try working around https://github.com/rust-lang/cargo/issues/4133 2024-10-04 17:25:06 -04:00
J / Jacob Babich
1493425540 ci: I must've hallucinated aarch64-pc-windows-gnu because it seems to actually be aarch64-pc-windows-gnullvm 2024-10-04 17:12:46 -04:00
J / Jacob Babich
576a8e99c0 ci: rewrite step for installing Rust to specify the toolchain as an argument rather than - where it seems to be invalid when using a variable - the uses: revision 2024-10-04 17:10:03 -04:00
J / Jacob Babich
01ce1e85a8 ci: it seems aarch64-pc-windows-gnu requires a nightly toolchain for now 2024-10-04 17:06:35 -04:00
J / Jacob Babich
cd788e1ab8 ci: split checking formatting off into its own job that only needs to run once 2024-10-04 17:01:45 -04:00
J / Jacob Babich
65487b2378 ci: see if this basic matrix of build targets and runners works for checking, building, and testing 2024-10-04 16:59:08 -04:00
J / Jacob Babich
e4e2efafb9 ci: only test direct minimal dependencies and not transitive ones because, per what I recall of Jon Gjengset's thoughts on the matter, it means there's a bug in a dependency rather than a bug in this codebase (and a bug in an old and obsolete version of their crate at that, so what would be the point?) 2024-10-03 02:19:59 -04:00
J / Jacob Babich
0fcdfdae30 ci: install cargo-hack before cargo-minimal-versions as it appears to be a requirement 2024-10-03 02:15:54 -04:00
J / Jacob Babich
9e43655567 ci: test minimal dependencies in GitHub Actions 2024-10-03 02:14:07 -04:00
J
0bc9424db6 docs: write barebones installation and usage sections
Some checks are pending
Check, build, and test / check-build-and-test (push) Waiting to run
Release-plz / Release-plz (push) Waiting to run
2024-10-02 02:50:25 -04:00
J
4a13d61e25 docs: indicate the license options (MIT, Apache 2.0, or Unlicense) of the project 2024-10-02 02:25:33 -04:00
J / Jacob Babich
376893e566 docs: link to issue for starting to test MSRV in CI
Some checks failed
Check, build, and test / check-build-and-test (push) Has been cancelled
Release-plz / Release-plz (push) Has been cancelled
2024-09-30 16:03:56 -04:00
J
c8cde7dffc Merge pull request #4 from babichjacob/release-plz-2024-09-30T19-19-10Z
chore: release v0.0.4
2024-09-30 19:39:26 +00:00
release-plz-for-ac-qu-ai-nt[bot]
6f9b8e42e1 chore: release 2024-09-30 19:38:13 +00:00
J / Jacob Babich
59d976664f docs: explain the use of Conventional Commits, semantic versioning, Release-plz, and give examples of breaking changes 2024-09-30 15:37:38 -04:00
J / Jacob Babich
95541183ef docs: explain MSRV policy 2024-09-30 15:30:44 -04:00
J / Jacob Babich
b5e11f2c7f chore(cli-clap): or at least I hope chore is the right conventional commit type to use - switch println! to a tracing invocation (to verify that the tracing infrastructure works) 2024-09-30 15:18:34 -04:00
J / Jacob Babich
b2dfa6f8f1 feat(multibinary): initialize a basic tracing subscriber until this is changed to a directory one using tracing-appender at a later time 2024-09-30 14:58:22 -04:00
J / Jacob Babich
75952c947a feat: make tracing a crate feature and make it a default feature of the current crates 2024-09-30 14:56:57 -04:00
J / Jacob Babich
15c8a69cf3 docs: create a Mermaid diagram showing the intradependencies of this project
Some checks are pending
Check, build, and test / check-build-and-test (push) Waiting to run
Release-plz / Release-plz (push) Waiting to run
2024-09-30 02:40:09 -04:00
J
2e764e0d24 Merge pull request #3 from babichjacob/release-plz-2024-09-30T06-17-20Z
chore: release v0.0.3
2024-09-30 06:32:31 +00:00
22 changed files with 522 additions and 30 deletions

View File

@@ -3,6 +3,14 @@ name: Check, build, and test
on: on:
push: push:
branches: ["main"] branches: ["main"]
# This workflow is definitely expensive for GitHub,
# so let's not let files that won't affect the project's ability to build and test trigger it
paths-ignore:
- ".github/**"
- "**/.gitignore"
- "**/CHANGELOG.md"
- "**/README.md"
- "**/LICENSE-*"
pull_request: pull_request:
branches: ["main"] branches: ["main"]
@@ -10,28 +18,153 @@ env:
CARGO_TERM_COLOR: always CARGO_TERM_COLOR: always
jobs: jobs:
check-build-and-test: formatting:
runs-on: ubuntu-latest runs-on: ubuntu-latest
timeout-minutes: 15 timeout-minutes: 2
steps: steps:
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@v4 uses: actions/checkout@v4
- name: Install Rust toolchain - name: Install stable Rust toolchain
uses: dtolnay/rust-toolchain@stable uses: dtolnay/rust-toolchain@stable
- name: Formatting
run: cargo fmt --check --verbose
check-and-build:
strategy:
matrix:
minimal_or_latest:
- build_command: cargo minimal-versions build --direct --verbose
check_command: cargo minimal-versions check --direct --verbose
job_name_suffix: with minimal versions of direct dependencies
- build_command: cargo build --verbose
check_command: cargo check --verbose
job_name_suffix: (with latest (typically) versions of dependencies)
supporteds:
- runner: macos-latest
target: aarch64-apple-darwin
- runner: macos-latest
target: x86_64-apple-darwin
- install_prerequisite: sudo apt-get update && sudo apt-get install gcc-aarch64-linux-gnu
runner: ubuntu-latest
target: aarch64-unknown-linux-gnu
- install_prerequisite: sudo apt-get update && sudo apt-get install gcc-aarch64-linux-gnu
runner: ubuntu-latest
target: aarch64-unknown-linux-musl
- runner: ubuntu-latest
target: x86_64-unknown-linux-gnu
- runner: ubuntu-latest
target: x86_64-unknown-linux-musl
# I would like to support this but I don't know how to install the dependencies to be able to
# - runner: windows-latest
# target: aarch64-pc-windows-gnullvm
- runner: windows-latest
target: aarch64-pc-windows-msvc
- runner: windows-latest
target: x86_64-pc-windows-gnu
- runner: windows-latest
target: x86_64-pc-windows-msvc
name: Check and build ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }}) ${{ matrix.minimal_or_latest.job_name_suffix }}
runs-on: ${{ matrix.supporteds.runner }}
timeout-minutes: 5
env:
# https://github.com/rust-lang/stacker/issues/80#issuecomment-1547991131
CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER: aarch64-linux-gnu-gcc
CARGO_TARGET_AARCH64_UNKNOWN_LINUX_MUSL_LINKER: aarch64-linux-gnu-gcc # TODO: shouldn't this be something to do with musl, not gcc?
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install prerequisite build chain
if: matrix.supporteds.install_prerequisite
run: ${{ matrix.supporteds.install_prerequisite }}
- name: Install stable Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
targets: ${{ matrix.supporteds.target }}
- name: Install cargo-hack
uses: taiki-e/install-action@cargo-hack
- name: Install cargo-minimal-versions
uses: taiki-e/install-action@cargo-minimal-versions
- uses: Swatinem/rust-cache@v2
with:
shared-key: ${{ matrix.supporteds.target }}
cache-on-failure: "true"
- name: Check
run: ${{ matrix.minimal_or_latest.check_command }} --target ${{ matrix.supporteds.target }}
- name: Build
run: ${{ matrix.minimal_or_latest.build_command }} --target ${{ matrix.supporteds.target }}
test:
strategy:
matrix:
supporteds:
- runner: macos-latest
target: aarch64-apple-darwin
- runner: macos-latest
target: x86_64-apple-darwin
# Not able to be tested in GitHub Actions (without emulation, at least)
# - runner: ubuntu-latest
# target: aarch64-unknown-linux-gnu
# Not able to be tested in GitHub Actions (without emulation, at least)
# - runner: ubuntu-latest
# target: aarch64-unknown-linux-musl
- runner: ubuntu-latest
target: x86_64-unknown-linux-gnu
- runner: ubuntu-latest
target: x86_64-unknown-linux-musl
# Not able to be tested in GitHub Actions (without emulation, at least)
# - runner: windows-latest
# target: aarch64-pc-windows-gnullvm
# Not able to be tested in GitHub Actions (without emulation, at least)
# - runner: windows-latest
# target: aarch64-pc-windows-msvc
- runner: windows-latest
target: x86_64-pc-windows-gnu
- runner: windows-latest
target: x86_64-pc-windows-msvc
name: Test ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }})
runs-on: ${{ matrix.supporteds.runner }}
timeout-minutes: 5
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install stable Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
targets: ${{ matrix.supporteds.target }}
- name: Install Nextest - name: Install Nextest
uses: taiki-e/install-action@cargo-nextest uses: taiki-e/install-action@cargo-nextest
- uses: Swatinem/rust-cache@v2 - uses: Swatinem/rust-cache@v2
- name: Check
run: cargo check --verbose
- name: Formatting
run: cargo fmt --check --verbose
- name: Build
run: cargo build --verbose
- name: Test - name: Test
run: cargo nextest run run: cargo nextest run --target ${{ matrix.supporteds.target }}

View File

@@ -9,8 +9,48 @@ on:
jobs: jobs:
compile-and-publish: compile-and-publish:
runs-on: ubuntu-latest strategy:
timeout-minutes: 15 matrix:
supporteds:
- runner: macos-latest
target: aarch64-apple-darwin
- runner: macos-latest
target: x86_64-apple-darwin
- install_prerequisite: sudo apt-get update && sudo apt-get install gcc-aarch64-linux-gnu
runner: ubuntu-latest
target: aarch64-unknown-linux-gnu
- install_prerequisite: sudo apt-get update && sudo apt-get install gcc-aarch64-linux-gnu
runner: ubuntu-latest
target: aarch64-unknown-linux-musl
- runner: ubuntu-latest
target: x86_64-unknown-linux-gnu
- runner: ubuntu-latest
target: x86_64-unknown-linux-musl
# I would like to support this but I don't know how to install the dependencies to be able to
# - runner: windows-latest
# target: aarch64-pc-windows-gnullvm
- runner: windows-latest
target: aarch64-pc-windows-msvc
- runner: windows-latest
target: x86_64-pc-windows-gnu
- runner: windows-latest
target: x86_64-pc-windows-msvc
name: Compile ${{ matrix.supporteds.target }} for release (on ${{ matrix.supporteds.runner }})
runs-on: ${{ matrix.supporteds.runner }}
timeout-minutes: 10
env:
# https://github.com/rust-lang/stacker/issues/80#issuecomment-1547991131
CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER: aarch64-linux-gnu-gcc
CARGO_TARGET_AARCH64_UNKNOWN_LINUX_MUSL_LINKER: aarch64-linux-gnu-gcc # TODO: shouldn't this be something to do with musl, not gcc?
steps: steps:
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@v4 uses: actions/checkout@v4
@@ -19,11 +59,24 @@ jobs:
uses: dtolnay/rust-toolchain@stable uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2 - uses: Swatinem/rust-cache@v2
with:
shared-key: ${{ matrix.supporteds.target }}
cache-on-failure: "true"
- name: Build for release - name: Build for release
run: cargo build --release --verbose run: cargo build --release --verbose
- uses: taiki-e/upload-rust-binary-action@v1 # Have to do it like this because of https://github.com/actions/runner/issues/1985
- if: startsWith(github.event.release.tag_name, 'ac-qu-ai-nt-v')
uses: taiki-e/upload-rust-binary-action@v1
with: with:
bin: ac-qu-ai-nt bin: ac-qu-ai-nt
token: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}
target: ${{ matrix.supporteds.target }}
- if: startsWith(github.event.release.tag_name, 'ac-qu-ai-nt-cli-clap-v')
uses: taiki-e/upload-rust-binary-action@v1
with:
bin: ac-qu-ai-nt-cli-clap
token: ${{ secrets.GITHUB_TOKEN }}
target: ${{ matrix.supporteds.target }}

27
Cargo.lock generated
View File

@@ -4,9 +4,11 @@ version = 3
[[package]] [[package]]
name = "ac-qu-ai-nt" name = "ac-qu-ai-nt"
version = "0.0.3" version = "0.0.8"
dependencies = [ dependencies = [
"ac-qu-ai-nt-cli-clap", "ac-qu-ai-nt-cli-clap",
"ac-qu-ai-nt-gui-eframe",
"ac-qu-ai-nt-tui-ratatui",
"clap", "clap",
"dirs-next", "dirs-next",
"tracing-subscriber", "tracing-subscriber",
@@ -14,12 +16,33 @@ dependencies = [
[[package]] [[package]]
name = "ac-qu-ai-nt-cli-clap" name = "ac-qu-ai-nt-cli-clap"
version = "0.0.3" version = "0.0.5"
dependencies = [ dependencies = [
"clap", "clap",
"tracing", "tracing",
] ]
[[package]]
name = "ac-qu-ai-nt-core"
version = "0.0.1"
dependencies = [
"tracing",
]
[[package]]
name = "ac-qu-ai-nt-gui-eframe"
version = "0.0.1"
dependencies = [
"tracing",
]
[[package]]
name = "ac-qu-ai-nt-tui-ratatui"
version = "0.0.1"
dependencies = [
"tracing",
]
[[package]] [[package]]
name = "anstream" name = "anstream"
version = "0.6.15" version = "0.6.15"

View File

@@ -1,5 +1,5 @@
[workspace] [workspace]
members = ["cli-clap", "multibinary"] members = ["core", "cli-clap", "gui-eframe", "tui-ratatui", "multibinary"]
resolver = "2" resolver = "2"
[workspace.package] [workspace.package]

View File

@@ -1,4 +1,81 @@
# ac-qu-ai-nt
`ac-qu-ai-nt` is a project I'm working on, using artificial intelligence to break down the user's query, acquire knowledge, and transfer insights to the user('s mind). `ac-qu-ai-nt` is a project I'm working on, using artificial intelligence to break down the user's query, acquire knowledge, and transfer insights to the user('s mind).
This is a placeholder while I take small steps to build out the project. This is a placeholder while I take small steps to build out the project.
# Installation
## Automatically Updatable
You won't find it very useful yet, because it doesn't really do much of anything, but you can install the multibinary with [Binstall](https://github.com/cargo-bins/cargo-binstall). This means you don't need to have the same development environment (which will require the Vulkan SDK and CUDA Toolkit in the future) in order to use the program, because you'll just download a precompiled executable.
```sh
cargo-binstall -y ac-qu-ai-nt
```
Install [`cargo-update`](https://github.com/nabijaczleweli/cargo-update) and periodically run
```sh
cargo install-update --all
```
in order to keep this program up to date.
I'm not sure if you need a Rust compiler installed for either or if they can work standalone.
## Just the Executable
Head to [the Releases page](https://github.com/babichjacob/ac-qu-ai-nt/releases) and download the asset corresponding to your computer architecture and operating system.
Decompress the archive and place the executable contained within it somewhere useful to you (e.g. in a directory in [your `PATH` variable](https://superuser.com/a/284351)).
# Usage
If it's your preference, you should be able to double click the executable in the folder to be able to run it (defaulting to launching a graphical interface (once I actually make one lol)).
You could also type
```sh
ac-qu-ai-nt
```
on the command line to run it. This is also a way to launch a GUI (once there actually is one) for the application.
## Command Line Interface
It's going to be a goal of this project for there to be feature parity between the GUI, CLI, and TUI.
If you want to use its command line interface, start with
```sh
ac-qu-ai-nt cli
```
to see what capabilities are available.
(This is an alias for `ac-qu-ai-nt cli-clap` to allow the possibility of experimenting with different implementations of the same type of interface.)
# Contributing
This is a summary of the crates I expect to be in this project and how they are used:
```mermaid
flowchart TD
core --> cli-clap
core --> gui-eframe
core --> tui-ratatui
cli-clap --> multibinary
gui-eframe --> multibinary
tui-ratatui --> multibinary
```
## Versioning
This project aims to adhere to [semantic versioning](https://semver.org/) using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary), conducted by [Release-plz](https://release-plz.ieni.dev/).
To be more specific about what a breaking change _could_ entail:
- a previously successful compilation now failing
- the program (wrongly) exiting, panicking, reporting an error, etc, where it didn't previously
- changing the expected result of an existing integration test (not sure if unit tests would count)
All the crates in this project have a [minimum supported Rust version (MSRV)](https://rust-lang.github.io/rfcs/2495-min-rust-version.html) of 1.76, the release succeeding [the one that stabilized `async fn` in traits](https://blog.rust-lang.org/2023/12/28/Rust-1.75.0.html) (which the `core` crate of this project is expected to make use of). I [intend to test this in CI (GitHub Actions) in the future](https://github.com/babichjacob/ac-qu-ai-nt/issues/5) to identify if it ever gets raised by changes but I have not set this up yet. Raising the MSRV will be considered a breaking change --- my justification is that it [seems more appropriate for an application like this](https://github.com/matklad/once_cell/issues/201#issuecomment-1257213601). This may be reconsidered if [Cargo's MSRV-aware resolver](https://rust-lang.github.io/rfcs/3537-msrv-resolver.html) is stabilized.
## License
All contents of this repository are licensed under either the
* [MIT license](LICENSE-MIT), or
* [Apache 2.0 license](LICENSE-APACHE), or
* [Unlicense](LICENSE-UNLICENSE)
at your option.

View File

@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased] ## [Unreleased]
## [0.0.5](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-cli-clap-v0.0.4...ac-qu-ai-nt-cli-clap-v0.0.5) - 2024-10-05
### Other
- change `Hello, world!` to `What's up world?` to allow me to cut a release
## [0.0.4](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-cli-clap-v0.0.3...ac-qu-ai-nt-cli-clap-v0.0.4) - 2024-09-30
### Added
- make `tracing` a crate feature and make it a default feature of the current crates
### Other
- *(cli-clap)* or at least I hope chore is the right conventional commit type to use - switch `println!` to a `tracing` invocation (to verify that the tracing infrastructure works)
## [0.0.3](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-cli-clap-v0.0.2...ac-qu-ai-nt-cli-clap-v0.0.3) - 2024-09-30 ## [0.0.3](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-cli-clap-v0.0.2...ac-qu-ai-nt-cli-clap-v0.0.3) - 2024-09-30
### Other ### Other

View File

@@ -1,7 +1,7 @@
[package] [package]
name = "ac-qu-ai-nt-cli-clap" name = "ac-qu-ai-nt-cli-clap"
description = "A CLI (written with clap) for ac-qu-ai-nt" description = "A CLI (written with clap) for ac-qu-ai-nt"
version = "0.0.3" version = "0.0.5"
edition = "2021" edition = "2021"
rust-version = "1.76" rust-version = "1.76"
@@ -9,6 +9,10 @@ authors = { workspace = true }
license = { workspace = true } license = { workspace = true }
repository = { workspace = true } repository = { workspace = true }
[features]
default = ["tracing"]
tracing = ["dep:tracing"]
[dependencies] [dependencies]
clap = { workspace = true, features = ["derive", "env"] } clap = { workspace = true, features = ["derive", "env"] }
tracing = { workspace = true } tracing = { workspace = true, optional = true }

View File

@@ -1,3 +1,4 @@
pub fn main() { pub fn main() {
println!("Hello, world!"); #[cfg(feature = "tracing")]
tracing::info!("What's up, world?");
} }

18
core/CHANGELOG.md Normal file
View File

@@ -0,0 +1,18 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [0.0.1](https://github.com/babichjacob/ac-qu-ai-nt/releases/tag/ac-qu-ai-nt-core-v0.0.1) - 2024-10-06
### Added
- initialize `core`, `gui-eframe`, and `tui-ratatui` crates and use them in the `multibinary`
### Other
- run cargo fmt

17
core/Cargo.toml Normal file
View File

@@ -0,0 +1,17 @@
[package]
name = "ac-qu-ai-nt-core"
description = "The core library of ac-qu-ai-nt. If you're looking for the application, see cli-clap or gui-eframe or tui-ratatui or the multibinary"
version = "0.0.1"
edition = "2021"
rust-version = "1.76"
authors = { workspace = true }
license = { workspace = true }
repository = { workspace = true }
[features]
default = ["tracing"]
tracing = ["dep:tracing"]
[dependencies]
tracing = { workspace = true, optional = true }

1
core/src/lib.rs Normal file
View File

@@ -0,0 +1 @@

14
gui-eframe/CHANGELOG.md Normal file
View File

@@ -0,0 +1,14 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [0.0.1](https://github.com/babichjacob/ac-qu-ai-nt/releases/tag/ac-qu-ai-nt-gui-eframe-v0.0.1) - 2024-10-06
### Added
- initialize `core`, `gui-eframe`, and `tui-ratatui` crates and use them in the `multibinary`

17
gui-eframe/Cargo.toml Normal file
View File

@@ -0,0 +1,17 @@
[package]
name = "ac-qu-ai-nt-gui-eframe"
description = "A GUI (written with egui / eframe) for ac-qu-ai-nt"
version = "0.0.1"
edition = "2021"
rust-version = "1.76"
authors = { workspace = true }
license = { workspace = true }
repository = { workspace = true }
[features]
default = ["tracing"]
tracing = ["dep:tracing"]
[dependencies]
tracing = { workspace = true, optional = true }

4
gui-eframe/src/lib.rs Normal file
View File

@@ -0,0 +1,4 @@
pub fn main() {
#[cfg(feature = "tracing")]
tracing::info!("Hello from the eframe-based GUI!");
}

1
gui-eframe/src/main.rs Normal file
View File

@@ -0,0 +1 @@
use ac_qu_ai_nt_gui_eframe::main;

View File

@@ -7,6 +7,43 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased] ## [Unreleased]
## [0.0.8](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-v0.0.7...ac-qu-ai-nt-v0.0.8) - 2024-10-06
### Added
- initialize `core`, `gui-eframe`, and `tui-ratatui` crates and use them in the `multibinary`
## [0.0.7](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-v0.0.6...ac-qu-ai-nt-v0.0.7) - 2024-10-05
### Other
- updated the following local packages: ac-qu-ai-nt-cli-clap
## [0.0.6](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-v0.0.5...ac-qu-ai-nt-v0.0.6) - 2024-10-05
### Fixed
- cover the new cases of `Command` for `GuiEframe` and `TuiRatatui`
### Other
- correctly add `gui-eframe` and `tui-ratatui` as features this time around
- add `gui-eframe` and `tui-ratatui` as subcommands with aliases `gui` and `tui` respectively
- add `gui-eframe` and `tui-ratatui` as features
## [0.0.5](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-v0.0.4...ac-qu-ai-nt-v0.0.5) - 2024-10-05
### Other
- [**breaking**] put accessing the cli under a subcommand like the README suggests it would be
## [0.0.4](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-v0.0.3...ac-qu-ai-nt-v0.0.4) - 2024-09-30
### Added
- *(multibinary)* initialize a basic tracing subscriber until this is changed to a directory one using `tracing-appender` at a later time
- make `tracing` a crate feature and make it a default feature of the current crates
## [0.0.3](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-v0.0.2...ac-qu-ai-nt-v0.0.3) - 2024-09-30 ## [0.0.3](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-v0.0.2...ac-qu-ai-nt-v0.0.3) - 2024-09-30
### Added ### Added

View File

@@ -1,7 +1,7 @@
[package] [package]
name = "ac-qu-ai-nt" name = "ac-qu-ai-nt"
description = "A WIP project using AI to break down a user's query, acquire the knowledge to answer it, then transfer those insights to the user" description = "A WIP project using AI to break down a user's query, acquire the knowledge to answer it, then transfer those insights to the user"
version = "0.0.3" version = "0.0.8"
edition = "2021" edition = "2021"
rust-version = "1.76" rust-version = "1.76"
@@ -10,11 +10,25 @@ license = { workspace = true }
repository = { workspace = true } repository = { workspace = true }
[features] [features]
default = ["cli-clap"] default = ["cli-clap", "gui-eframe", "tui-ratatui", "tracing"]
cli-clap = ["dep:ac-qu-ai-nt-cli-clap"] cli-clap = ["dep:ac-qu-ai-nt-cli-clap"]
gui-eframe = ["dep:ac-qu-ai-nt-gui-eframe"]
tui-ratatui = ["dep:ac-qu-ai-nt-tui-ratatui"]
tracing = [
"dep:tracing-subscriber",
"ac-qu-ai-nt-cli-clap?/tracing",
"ac-qu-ai-nt-gui-eframe?/tracing",
"ac-qu-ai-nt-tui-ratatui?/tracing",
]
[dependencies] [dependencies]
ac-qu-ai-nt-cli-clap = { version = "0.0.3", path = "../cli-clap", optional = true } ac-qu-ai-nt-cli-clap = { version = "0.0.5", path = "../cli-clap", optional = true }
ac-qu-ai-nt-gui-eframe = { version = "0.0.1", path = "../gui-eframe", optional = true }
ac-qu-ai-nt-tui-ratatui = { version = "0.0.1", path = "../tui-ratatui", optional = true }
clap = { workspace = true, features = ["derive", "env"] } clap = { workspace = true, features = ["derive", "env"] }
dirs-next = "2.0.0" dirs-next = "2.0.0"
tracing-subscriber = "0.3.18"
tracing-subscriber = { version = "0.3.18", optional = true }

View File

@@ -1,6 +1,6 @@
use std::{fs::create_dir_all, io::ErrorKind, path::PathBuf}; use std::{fs::create_dir_all, io::ErrorKind, path::PathBuf};
use clap::Parser; use clap::{Parser, Subcommand};
#[derive(Debug, Parser)] #[derive(Debug, Parser)]
struct Args { struct Args {
@@ -10,13 +10,33 @@ struct Args {
default_value_os_t = dirs_next::data_local_dir().expect("sorry but you're on a platform where dirs_next::data_local_dir() returned None, so please specify a data directory for the application").join("ac-qu-ai-nt") default_value_os_t = dirs_next::data_local_dir().expect("sorry but you're on a platform where dirs_next::data_local_dir() returned None, so please specify a data directory for the application").join("ac-qu-ai-nt")
)] )]
application_data_directory: PathBuf, application_data_directory: PathBuf,
#[command(subcommand)]
command: Command,
}
#[derive(Debug, Subcommand)]
enum Command {
#[cfg(feature = "cli-clap")]
#[command(alias = "cli")]
CliClap,
#[cfg(feature = "gui-eframe")]
#[command(alias = "gui")]
GuiEframe,
#[cfg(feature = "tui-ratatui")]
#[command(alias = "tui")]
TuiRatatui,
} }
fn main() { fn main() {
let Args { let Args {
application_data_directory, application_data_directory,
command,
} = Args::parse(); } = Args::parse();
#[cfg(feature = "tracing")]
tracing_subscriber::fmt::init();
match create_dir_all(&application_data_directory) { match create_dir_all(&application_data_directory) {
Ok(()) => {} Ok(()) => {}
Err(e) if e.kind() == ErrorKind::AlreadyExists => {} Err(e) if e.kind() == ErrorKind::AlreadyExists => {}
@@ -35,6 +55,12 @@ fn main() {
} }
} }
#[cfg(feature = "cli-clap")] match command {
ac_qu_ai_nt_cli_clap::main(); #[cfg(feature = "cli-clap")]
Command::CliClap => ac_qu_ai_nt_cli_clap::main(),
#[cfg(feature = "gui-eframe")]
Command::GuiEframe => ac_qu_ai_nt_gui_eframe::main(),
#[cfg(feature = "tui-ratatui")]
Command::TuiRatatui => ac_qu_ai_nt_tui_ratatui::main(),
}
} }

14
tui-ratatui/CHANGELOG.md Normal file
View File

@@ -0,0 +1,14 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [0.0.1](https://github.com/babichjacob/ac-qu-ai-nt/releases/tag/ac-qu-ai-nt-tui-ratatui-v0.0.1) - 2024-10-06
### Added
- initialize `core`, `gui-eframe`, and `tui-ratatui` crates and use them in the `multibinary`

17
tui-ratatui/Cargo.toml Normal file
View File

@@ -0,0 +1,17 @@
[package]
name = "ac-qu-ai-nt-tui-ratatui"
description = "A TUI (written with Ratatui) for ac-qu-ai-nt"
version = "0.0.1"
edition = "2021"
rust-version = "1.76"
authors = { workspace = true }
license = { workspace = true }
repository = { workspace = true }
[features]
default = ["tracing"]
tracing = ["dep:tracing"]
[dependencies]
tracing = { workspace = true, optional = true }

4
tui-ratatui/src/lib.rs Normal file
View File

@@ -0,0 +1,4 @@
pub fn main() {
#[cfg(feature = "tracing")]
tracing::info!("This is from the TUI based on Ratatui.");
}

1
tui-ratatui/src/main.rs Normal file
View File

@@ -0,0 +1 @@
use ac_qu_ai_nt_tui_ratatui::main;