Closed namchuai closed 1 week ago
Installer:
.exe
C:\Users\<username>\AppData\Local\cortex\cortex.exe
C:\Users\<username>\AppData\Local\cortex-beta\cortex-beta.exe
C:\Users\<username>\AppData\Local\cortex-nightly\cortex-nightly.exe
C:\Users\<username>\.cortexrc
C:\Users\<username>\.cortexrc-beta
C:\Users\<username>\.cortexrc-nightly
C:\Users\<username>\.cortexcpp
C:\Users\<username>\.cortexcpp-beta
C:\Users\<username>\.cortexcpp-nightly
.deb
/usr/bin/cortex
/usr/bin/cortex-beta
/usr/bin/cortex-nightly
/home/<username>/.cortexrc
/home/<username>/.cortexrc-beta
/home/<username>/.cortexrc-nightly
/home/<username>/.cortex
/home/<username>/.cortexcpp-beta
/home/<username>/.cortexcpp-nightly
.pkg
/usr/local/bin/cortex
/usr/local/bin/cortex-beta
/usr/local/bin/cortex-nightly
/Users/<username>/.cortexrc
/Users/<username>/.cortexrc-beta
/Users/<username>/.cortexrc-nightly
/Users/<username>/.cortexcpp
/Users/<username>/.cortexcpp-beta
/Users/<username>/.cortexcpp-nightly
@hiento09 I spot some inconsistencies in your folder/file naming vs #1040
@hiento09 I spot some inconsistencies in your folder/file naming vs #1040
I just edited my comment base on this comment https://github.com/janhq/cortex/issues/1040#issuecomment-2327938276 from @dan-homebrew
@hiento09 I made some changes to your folder/binary layout, based on our earlier discussion #1092
cortex
, and binary name is cortex
(or cortex-beta
, cortex-nightly
)cortexcpp
(with versions: cortexcpp-beta
, cortexcpp-nightly
)product-version
Installer:
.exe
C:\Users\<username>\AppData\Local\cortexcpp\cortex.exe
C:\Users\<username>\AppData\Local\cortexcpp-beta\cortex-beta.exe
C:\Users\<username>\AppData\Local\cortexcpp-nightly\cortex-nightly.exe
C:\Users\<username>\.cortexrc
C:\Users\<username>\.cortexrc-beta
C:\Users\<username>\.cortexrc-nightly
C:\Users\<username>\.cortexcpp
C:\Users\<username>\.cortexcpp-beta
C:\Users\<username>\.cortexcpp-nightly
.deb
/usr/bin/cortexcpp
/usr/bin/cortexcpp-beta
/usr/bin/cortexcpp-nightly
/home/<username>/.cortexrc
/home/<username>/.cortexrc-beta
/home/<username>/.cortexrc-nightly
/home/<username>/.cortexcpp
/home/<username>/.cortexcpp-beta
/home/<username>/.cortexcpp-nightly
.pkg
/usr/local/bin/cortexcpp
/usr/local/bin/cortexcpp-beta
/usr/local/bin/cortexcpp-nightly
/Users/<username>/.cortexrc
/Users/<username>/.cortexrc-beta
/Users/<username>/.cortexrc-nightly
/Users/<username>/.cortexcpp
/Users/<username>/.cortexcpp-beta
/Users/<username>/.cortexcpp-nightly
@hiento09 I made some changes to your folder/binary layout, based on our earlier discussion #1092
Changes
CLI command is
cortex
, and binary name iscortex
(orcortex-beta
,cortex-nightly
)Our convention is to hyphenate
name-version
Data folder is pending discussion on visible vs. hidden folder in #1040
Installer:
Windows
Format:
.exe
Binary location:
Stable:
C:\Users\<username>\AppData\Local\cortexcpp\cortex.exe
Beta:
C:\Users\<username>\AppData\Local\cortexcpp-beta\cortex-beta.exe
Nighty:
C:\Users\<username>\AppData\Local\cortexcpp-nightly\cortex-nightly.exe
Configuration file:
Stable:
C:\Users\<username>\.cortexrc
Beta:
C:\Users\<username>\.cortexrc-beta
Nighty:
C:\Users\<username>\.cortexrc-nightly
Data folder (contains engines, models, logs)
Stable:
C:\Users\<username>\.cortexcpp
Beta:
C:\Users\<username>\.cortexcpp-beta
Nighty:
C:\Users\<username>\.cortexcpp-nightly
Linux:
Format:
.deb
Binary location:
Stable:
/usr/bin/cortexcpp
Beta:
/usr/bin/cortexcpp-beta
Nighty:
/usr/bin/cortexcpp-nightly
Configuration file:
Stable:
/home/<username>/.cortexrc
Beta:
/home/<username>/.cortexrc-beta
Nighty:
/home/<username>/.cortexrc-nightly
Data folder (contains engines, models, logs)
Stable:
/home/<username>/.cortexcpp
Beta:
/home/<username>/.cortexcpp-beta
Nighty:
/home/<username>/.cortexcpp-nightly
Macos:
Format:
.pkg
Binary location:
Stable:
/usr/local/bin/cortexcpp
Beta:
/usr/local/bin/cortexcpp-beta
Nighty:
/usr/local/bin/cortexcpp-nightly
Configuration file:
Stable:
/Users/<username>/.cortexrc
Beta:
/Users/<username>/.cortexrc-beta
Nighty:
/Users/<username>/.cortexrc-nightly
Data folder (contains engines, models, logs)
Stable:
/Users/<username>/.cortexcpp
Beta:
/Users/<username>/.cortexcpp-beta
Nighty:
/Users/<username>/.cortexcpp-nightly
Thank you @dan-homebrew
Task to do here https://github.com/janhq/cortex.cpp/issues/1030
For installer, llamacpp engine will be installed by default
@hiento09 Can I clarify my understanding of the Installer, as there are a couple of things that are not aligned from our discussion last week:
Last week's discussion: https://link.excalidraw.com/l/kFY0dI05mm/3rpQK5NI8Xb
cortex init <engine>
For the 3 operating systems, my understanding was as follows:
.exe
.dmg
.deb
and .appimage
later on), in the format of: curl -fsSL https://get.cortex.so -o get-cortex.sh
From the post above, it seems like we're going directly to .deb
and .appImage
.
My question: Does the .deb
and .appImage
wrap the Installer Script? There are definite advantages to having a .deb
and .appimage
, I just want to know how much more effort it is.
My understanding is that our Installation logic focuses on two tasks:
I am increasingly thinking that it is a better idea for us to pack a larger installer:
My question: Does the
.deb
and.appImage
wrap the Installer Script? There are definite advantages to having a.deb
and.appimage
, I just want to know how much more effort it is.
This is an example of template structure for .deb file in linux
Yes, it wraps bash scripts and allows us to interact with hooks like pre-install
, post-install
, pre-uninstall
, and post-uninstall
. It also has installation and uninstallation functions. If we go with a bash script, then we have to write all of the above functions ourselves.
Link the final decision for naming here https://github.com/janhq/cortex.cpp/issues/1092
Motivation Couple of options:
brew install cortexcpp
or something like that)Related Issues
775