https://github.com/fatalus69/valkyrie
A package manager for Odin
https://github.com/fatalus69/valkyrie
odin package-manager
Last synced: 6 months ago
JSON representation
A package manager for Odin
- Host: GitHub
- URL: https://github.com/fatalus69/valkyrie
- Owner: fatalus69
- Created: 2025-04-23T16:43:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-01T18:08:51.000Z (about 1 year ago)
- Last Synced: 2025-05-03T04:58:56.243Z (about 1 year ago)
- Topics: odin, package-manager
- Language: Odin
- Homepage:
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Valkyrie - A package manager for Odin
## Sketch and Future TODO's:
## GENERAL:
- CLI Name: valkyrie
- Package folder: runepkg
- Config Files: valkyrie.toml (dependencies and settings) & valkyrie.lock (pin exact versions, tags or commits)
- Import style: import "runepkg:foo"
### Commands:
- valkyrie install [package] – installs one package from ressource or all packages in valkyrie.toml
- valkyrie remove [package] - removes desired package
- valkyrie update [package] - updates all or desired package
- valkyrie init – starts an interactive setup
- valkyrie clean-install - wipes + reinstalls all packages
- valkyrie list - list installed packages
##### Maybe:
- valkyrie doctor - check setup of toml
- valkyrie validate - check for invalid toml
- valkyrie graph - show dependency graph (future feature)
#### Dependency Format:
- git - with ref, tag or branch
- path - for local package development
- version (maybe)
#### Lock File:
- exact commit hash
- metadata
#### Stuff I should consider:
- A script that replaces import "runepkg:foo" with relative paths during build or a wrapper that does that during odin build
#### Example of valkyire.toml:
````toml
[dependencies]
foo = { git = "https://github.com/user/foo", rev = "main" }
bar = { git = "https://github.com/user/bar", tag = "v1.2.3" }
baz = { path = "../local_baz" }
````
#### Structure:
```
src/
├── main.odin # CLI entrypoint
├── cli/
│ ├── commands.odin # All commands and dispatch logic
│ ├── parser.odin # os.args[] parser & help output
├── core/
│ ├── config.odin # valkyrie.toml reading/writing
│ ├── lockfile.odin # valkyrie.lock reading/writing
│ ├── resolver.odin # dependency resolver (git clones, paths, etc)
│ ├── installer.odin # install/update/remove logic
│ ├── util.odin # helper stuff (string handling, error printing, etc)
└── types/
├── package.odin # structs for dependencies, versions, etc
└── config_schema.odin # if needed for TOML struct definitions
```
#### Important Structs:
```odin
Command = struct {
name: string,
requires_argument: bool,
fn: proc(arg: string),
}
Dependency = struct {
name: string,
source_type: enum { git, path },
url_or_path: string,
version: string, // rev/tag/branch
}
ProjectConfig = struct {
dependencies: map[string]Dependency,
}
```